compute_unit 0.3.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff898fab62731ca014ea856033f2e7d024e1013703af0cba4b194844b1fc683
-  data.tar.gz: 9c9e7b32eca6a7313c823ef6c96171f939882550c3f5ecd405c359640ed71e2d
+  metadata.gz: f51ca7c79e4dfb8a97f4221a0798a59169ddf4c925978bd2cff52633412573ab
+  data.tar.gz: 8e5b1cf6adad26fac8c54cdc54f3178af1a8e2325657e997419f98d8306d9e86
 SHA512:
-  metadata.gz: '08fb1888538fefb976eb66350eb1fb1afaac4901bc847b60532228ffbcdd565dc72448f318566dc5781d0a69b53c81ef47b32836e5b51eee0c4925c200e95792'
-  data.tar.gz: ea1603c5ff7aa307e7d566b50420a31e582b437255e2a6eff57f44981732e0c98865684035dec64da270bd59a457fd30250950e5cc5a28dad33cb338ef329a06
+  metadata.gz: b18314336244f86d4c7417def3bf97d90762696df44cd9a1f6bced80b6dca142afe6deb5cd8954795e773c974061d8737bf7635307305e96d9018e1a59fcef17
+  data.tar.gz: 9f3bc81ca0e1a0694733880217b6574e959e4eef538ab24bae28b081dafc962d763aa02214598bfa846603d9d83dbf497e1559a690e707655a7dc9cfae532544

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 # Compute Unit Changelog
 
-## Unrleased
+## 0.5.1
+Released 12/30/2020
+
+* Add cpu uuid and bios methods
+* Remove formatters module
+* Fix stack level when root? is used
+* Ensure cpu power is an integer
+## 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

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'
@@ -138,7 +144,7 @@ Instead of monkey patching this code you can simply subclass the objects.  The f
 
 ```ruby
 # coolproject/vegagpu.rb
-require 'cool_project/vega_gpu'
+require 'compute_unit/gpu/amdgpu'
 module CoolProject
   class VegaGpu < ::ComputeUnit::Gpu::AmdGpu
     include CoolProject::Metrics
@@ -183,7 +189,7 @@ The opencl_ruby_ffi gem is optionally used to gather additional info about the G
 
 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. 
+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 calculatulation 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:
 
@@ -201,7 +207,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/logicminds/compute_unit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/blockops/compute_unit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -209,4 +215,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ComputeUnit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/logicminds/compute_unit/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ComputeUnit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/blockops/compute_unit/-/blob/master/CODE_OF_CONDUCT.md).

data/compute_unit.gemspec

@@ -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,7 +11,7 @@ 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'
+  DEFAULT_PCIDB_PATH = '/usr/share/misc/pci.ids'
 
   # @param use_opencl [Boolean]
   # @return [Array] - return a list of compute units
@@ -20,16 +20,36 @@ module ComputeUnit
     require 'compute_unit/cpu'
     require 'compute_unit/asic'
 
-    copy_default_database unless File.exist?(PCI_DATABASE_PATH)
+    # if this file doesn't exist we need to fetch it or copy it
+    refresh_pci_database unless File.exist?(PCI_DATABASE_PATH)
 
-    ComputeUnit::Gpu.find_all(use_opencl) +
-      ComputeUnit::Cpu.find_all +
-      ComputeUnit::Asic.find_all
+    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 copy_default_database
-    File.cp(DEFAULT_PCIDB_PATH, PCI_DATABASE_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
@@ -40,7 +60,7 @@ module ComputeUnit
     find_all(use_opencl)
   end
 
-  # downloads the pci database 
+  # downloads the pci database
   def self.refresh_pci_database
     ComputeUnit::Utils.check_for_root
     require 'net/http'

data/lib/compute_unit/compute_base.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 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
 
-    include ComputeUnit::Formatters
     include ComputeUnit::Logger
 
     # timeout value
@@ -26,6 +27,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)
@@ -52,24 +71,5 @@ module ComputeUnit
     def expired_metadata?
       (timestamp + CACHE_TIMEOUT) < Time.now.to_i
     end
-
-    def experimental_on?
-      unless ENV['XB_EXPERIMENTAL'].to_s == '1'
-        logger.warn('You must set environment variable XB_EXPERIMENTAL=1 to use this feature')
-        return false
-      end
-      true
-    end
-
-    def micro_formatter(item, add_unit = false)
-      data = {}
-      item.each do |key, value|
-        if %i[hourly_cost hourly_earnings kwh_cost].include?(key)
-          v = (value * 1_000_000).round(4)
-          data[key] = add_unit ? "#{v} \u00B5BTC" : v
-        end
-      end
-      item.merge(data)
-    end
   end
 end

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,87 @@ module ComputeUnit
       end
     end
 
+    def bios
+      'N/A'
+    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,8 +117,43 @@ 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).to_i # 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: uuid,
+        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
       {
+        uuid: uuid,
         temp: temp,
         minFreqMhz: min_freq_mhz,
         maxFreqMhz: max_freq_mhz,
@@ -87,6 +171,20 @@ 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
+      @uuid = opts[:uuid] || opts[:serial]
+    end
+
+    # @return [String] - the type and index of the device
+    def uuid
+      @uuid ||= "#{type}#{index}"
+    end
+
     def self.create_from_path(device_path, index)
       opts = {
         device_class_id: device_class(device_path),
@@ -99,7 +197,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/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/utils.rb

@@ -11,7 +11,7 @@ module ComputeUnit
 
     # @return [Boolean] - return true if the current user is root
     def root?
-      root?
+      ::Etc.getpwuid.name == 'root'
     end
 
     # @return [Boolean] - returns true if user is root

data/lib/compute_unit/version.rb

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

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: compute_unit
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-12-30 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
@@ -105,7 +125,6 @@ files:
 - lib/compute_unit/cpu.rb
 - lib/compute_unit/device.rb
 - lib/compute_unit/exceptions.rb
-- lib/compute_unit/formatters.rb
 - lib/compute_unit/gpu.rb
 - lib/compute_unit/gpus/amd_gpu.rb
 - lib/compute_unit/gpus/nvidia_gpu.rb

data/lib/compute_unit/formatters.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module ComputeUnit
-  module Formatters
-    def micro_formatter(item, add_unit = false)
-      data = {}
-      item.each do |key, value|
-        if %i[hourly_cost hourly_earnings kwh_cost].include?(key)
-          v = (value * 1000000).round(4)
-          data[key] = add_unit ? "#{v} \u00B5BTC" : v
-        end
-      end
-      item.merge(data)
-    end
-
-    def value_micro_formatter(value, add_unit = false)
-      v = (value * 1000000).round(1)
-      add_unit ? "#{v} \u00B5BTC" : v
-    end
-  end
-end