compute_unit 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcc45e864245505b64cd82233ca7f8ad70d0d12ca1a976862ba46c80e66fefc8
-  data.tar.gz: 6903aff2b613ee6f88c41aa051e65404f31c8923bab2059323dfd27bc99cc5e0
+  metadata.gz: e7454de36f403e2803ee5b87ee989781de8b663d32cfe290b3c22ab0c18f598d
+  data.tar.gz: 6b6afa144e05011bec545ddbda688ae663650dce4d09070be9a3922f84bc9606
 SHA512:
-  metadata.gz: a971813c562bc8c29305f1fe3668f229b52bd018049d36879fcc943a935232e8d8bb34095e74643ca9d3da594796a4cdfdc33fe06b36a8501a75c0a330489cb3
-  data.tar.gz: bc17da953ab1904661c7037977c36b1dda69c7c4236c5854730743fa9332987a92ba3891e97052c4ee9361bea7a0b830a917235e15f1db75e8246b7835715a6e
+  metadata.gz: 3821595267038d8424a7ae3558437339f87b871ce4e294ffe80cce1c928924a9ae1ebd7fa9b293c08a2b40217a71f7a4358e8a943456dd0c978cf7e4bfbb5a0a
+  data.tar.gz: 4fa97e267f9fd8c60999d8af1dd96e15e9e77435c98ece688e53386147e0e7470b1f9a7e149f702fbcb237fbf6c41085f051db9ad441e1388dbde6ce9d2469a5

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Compute Unit Changelog
 
-## Unrleased
+## 0.5.0
+Released 10/5/2020
+
+* Add more method docs
+* Allow overriding of cpu power
+* Update cpu name using model
+* Add new search methods
+* Add voltage and other cpu metrics
+## 0.4.0
+* Adds ability to list attached processes to compute_unit sorted by field
+* Adds ability to list top_x attached processes sorted by field
+
+## 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

data/README.md

@@ -35,6 +35,12 @@ Or install it yourself as:
 
 ## Usage
 
+Ensure the pci database exist on your system.  You can update it at anytime with the built in linux command.
+
+`/usr/sbin/update-pciids` or the command from this gem `update_pcidb` installed in your gem bin directory.
+
+Additionally, when using the `ComputeUnit.find_all_with_database` method.
+
 Find all compute devices
 ```
 require 'compute_unit'

data/compute_unit.gemspec

@@ -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.md"
+  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.
@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-
+  spec.add_dependency 'sys-proctable', '~> 1.2', '>= 1.2.0'
   spec.add_dependency 'opencl_ruby_ffi', '~> 1.3.4'
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13'

data/lib/compute_unit.rb

@@ -11,23 +11,56 @@ 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/misc/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)
 
-    ComputeUnit::Gpu.find_all(use_opencl) +
-      ComputeUnit::Cpu.find_all +
-      ComputeUnit::Asic.find_all
+    # if this file doesn't exist we need to fetch it or copy it
+    refresh_pci_database unless File.exist?(PCI_DATABASE_PATH)
+
+    Gpu.find_all(use_opencl) + Cpu.find_all + Asic.find_all
+  end
+
+  # @param pid [Integer] the pid to search with
+  # @param field [Symbol] - the field to sort by
+  # @return [Array] - a array of device paths
+  # @example usage
+  #   device_paths_by_process(3748) => ["/sys/bus/pci/devices/0000:00:00.0"]
+  def self.device_paths_by_process(pid)
+    # processes = ComputeUnit::Cpu.attached_processes(field).last(1) + ComputeUnit::Gpu.attached_processes(field)
+    # processes.find_all { |process| process.pid == pid }
+    # We can get the utilized devices but it appears cubersome to convert to a device path
+    # This method uses more resources
+    find_by_process(pid).map(&:device_path)
+  end
+
+  # @param pid [Integer] the pid to search with
+  # @param use_opencl [Boolean] use opencl on gpu devices
+  def self.find_by_process(pid, use_opencl = false)
+    find_all(use_opencl).find_all do |unit|
+      unit.top_processes.first.pid.to_i == pid.to_i
+    end
+  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) if File.exist?(DEFAULT_PCIDB_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/compute_base.rb

@@ -4,9 +4,12 @@ require 'time'
 require 'compute_unit/formatters'
 require 'compute_unit/logger'
 require 'compute_unit/device'
+require 'sys/proctable'
 
 module ComputeUnit
   class ComputeBase < Device
+    include Sys
+
     attr_reader :type, :serial, :meta, :uuid, :timestamp, :index, :compute_type
     attr_accessor :power_offset
 
@@ -26,6 +29,24 @@ module ComputeUnit
       end
     end
 
+    # @summary Finds all cpu attached processes and sorts by pctcpu
+    # param filter [Regex] - if supplied filter out devices from fd list
+    # @param field [Symbol] - the field to sort by
+    # @return [Array] - an array of attached processes
+    def attached_processes(field = :pctcpu, filter = nil)
+      raise NotImplementedError unless self.class.respond_to?(:attached_processes)
+
+      self.class.attached_processes(field, filter)
+    end
+
+    # @summary Find the processes consuming the most cpu
+    # @param x [Integer] the number of processes to return, defaults to 1
+    # @param field [Symbol] - the field to sort by
+    # @return [Array] - an array of attached processes
+    def top_processes(x = 1, field = :pctcpu)
+      attached_processes(field).last(x)
+    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

@@ -6,8 +6,8 @@ module ComputeUnit
   class Cpu < ComputeBase
     DEVICE_CLASS = '060000'
     DEVICE_CLASS_NAME = 'CPU'
+    VOLTAGE_MSR = 0x198
     # @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|
@@ -15,38 +15,83 @@ module ComputeUnit
       end
     end
 
+    def utilization
+      1 # until we can calculate this.  Is loadavg a good metric? or load / cpus
+    end
+
+    # @summary Finds all cpu attached processes and sorts by pctcpu
+    # @param field [Symbol] - the field to sort by
+    # @param filter [Regex] - if supplied filter out devices from fd list
+    # @return [Array] - an array of attached processes
+    def self.attached_processes(field = :pctcpu, _filter = nil)
+      Sys::ProcTable.ps(smaps: false).sort_by(&field)
+    end
+
+    # @summary [Float] - returns the voltage of the cpu
+    # @param processor_id [Integer] - the id of the cpu
+    def voltage(processor_id = 0)
+      file = "/dev/cpu/#{processor_id}/msr"
+      return 0 unless File.exist?(file)
+
+      # read 8 bytes, then unpack it by turning it into an integer
+      # make it a binary string, pluck out some specific bits, then
+      # convert it back to an integer
+      # divide by 8192 to give the voltage
+      # lowbit = 32
+      # highbit = 47
+      # bits = 47 - 32 + 1 # we want to read bits 32-47
+      msr = IO.new IO.sysopen(file, 'rb')
+      msr.sysseek(VOLTAGE_MSR)
+      data, = msr.sysread(8).unpack('q')
+      format('%.2f', ((data >> 32) / 8192.to_f))
+    end
+
+    # @return [String] - the model / name of the cpu
     def model
       raw_cpu_data[:model_name]
     end
 
+    # @return [String] - the model / name of the cpu
+    def name
+      model
+    end
+
+    # @return [String] - the maker of the cpu
     def make
       raw_cpu_data[:vendor_id]
     end
 
+    # @return [Integer] - the number of cores
     def num_cores
       raw_cpu_data[:cores_per_socket].to_i
     end
 
+    # @return [Integer] - the number of threads
     def num_threads
       raw_cpu_data[:threads_per_core].to_i
     end
 
+    # @return [Integer] - the number of cpus
     def nproc
       raw_cpu_data[:cpus].to_i
     end
 
+    # @return [Float] - current mhz of cpu
     def current_freq_mhz
       raw_cpu_data[:cpu_mhz].to_f.round(0)
     end
 
+    # @return [Float] - max mhz of cpu
     def max_freq_mhz
       raw_cpu_data[:cpu_max_mhz].to_f.round(0)
     end
 
+    # @return [Float] - current min of cpu
     def min_freq_mhz
       raw_cpu_data[:cpu_min_mhz].to_f.round(0)
     end
 
+    # @return [String] the path of the hwmon path for monitoring temps
     def base_hwmon_path
       File.join(ComputeUnit::SYSFS_PATH, 'devices/platform/coretemp.0/hwmon')
     end
@@ -68,6 +113,40 @@ module ComputeUnit
       read_hwmon_data('temp1_input', 0).to_f.round(0) / 1000
     end
 
+    def status
+      0
+    end
+
+    def power
+      ENV.fetch('CPU_POWER', 60) # until we can calculate power we will just use 60
+    end
+
+    def fan
+      2500 # until we can calculate fan speed
+    end
+
+    def mem_temp
+      0 # until we can get the mem temp
+    end
+
+    def pci_loc
+      device_path
+    end
+
+    def status_info
+      { index: "CPU#{index}",
+        name: model,
+        bios: 'N/A',
+        core_clock: current_freq_mhz,
+        memory_clock: 'N/A',
+        power: power,
+        fan: fan,
+        core_volt: voltage,
+        temp: temp,
+        mem_temp: mem_temp,
+        status: status }
+    end
+
     def metrics
       {
         temp: temp,
@@ -87,6 +166,14 @@ module ComputeUnit
       super.merge(metrics)
     end
 
+    def initialize(_device_path, opts)
+      super
+      @type = :CPU
+      @pci_loc = device_path,
+                 @index = opts[:index].to_i
+      @power_offset = 0
+    end
+
     def self.create_from_path(device_path, index)
       opts = {
         device_class_id: device_class(device_path),
@@ -99,7 +186,7 @@ module ComputeUnit
       new(device_path, opts)
     end
 
-    def self.find_all
+    def self.find_all(_use_opencl = false)
       devices.sort.map.with_index do |device_path, index|
         create_from_path(device_path, index)
       end

data/lib/compute_unit/device.rb

@@ -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

data/lib/compute_unit/gpu.rb

@@ -13,6 +13,19 @@ module ComputeUnit
       type
     end
 
+    # @summary Finds all cpu attached processes and sorts by pctcpu
+    # @param filter [Regex] - if supplied filter out devices from fd list
+    # @param field [Symbol] - the field to sort by
+    # @return [Array] - an array of attached processes
+    def self.attached_processes(field = :pctcpu, filter = %r{/dev/dri|nvidia\d+})
+      filter ||= %r{/dev/dri|nvidia\d+}
+      # looks for any fd device with dri or nvidia in the name
+      p = Sys::ProcTable.ps(smaps: false).find_all do |p|
+        p.fd.values.find { |f| f =~ filter }
+      end
+      p.sort_by(&field)
+    end
+
     # @return [OpenCL_Device]
     def opencl_device
       @opencl_device ||= self.class.opencl_devices.find_all { |cu| cu[:type] == make }[index] if use_opencl

data/lib/compute_unit/version.rb

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

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: compute_unit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-11-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: opencl_ruby_ffi
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +139,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.md
+  changelog_uri: https://gitlab.com/blockops/compute_unit/-/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: