hyperctl 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd42c9d0ce6995577336ac5d079c38b2dbcf5f0b
-  data.tar.gz: d71520d05bb74c3bb584868fbdb9663be22b7b6c
+  metadata.gz: f0b2b0f0133da7e528821e2c7424a4fd5bfc4163
+  data.tar.gz: c77ebe50391c5405b75bfe8121f8edf040492576
 SHA512:
-  metadata.gz: d90ca4e32248d536a58eb2a9f463e69caa9cbf8617d2d9e0b86358f38f95e2727292476c0ac94ba5acceadf373ee4c6db6075f7cacbd19acfbad78f63bc856d8
-  data.tar.gz: f3fdfd9fbc3ee5c449efddcd8af2daf59ed74123efe78769add4bffd3d9e7ae87942133907d3504cc65c51fb7a8f4783f2313056f63eaa2d2e511b2c24d4d523
+  metadata.gz: bab6dea8336e756ffa21d23d5ff41410adcc56a13dea20bb5ff0eb1b25aaaebe1fc6d3eb58b24b1ecb80c949212a9ac7e17ca6a2639a3b09fca4a5a75269ca42
+  data.tar.gz: d8864acf582d1a736fc4112a005475b6097e5f2e80969350827f3e1d5423eabdf9e18aadee0b497b7b9d1e8a2e586a6e646e400a6cc799faeea250621941a646

data/lib/hyperctl.rb

@@ -1,4 +1,5 @@
 require 'hyperctl/sysfs'
+require 'hyperctl/version'
 
 module Hyperctl
   # Enable all sibling cores

data/lib/hyperctl/sysfs.rb

@@ -1,189 +1,193 @@
-class Hyperctl::Sysfs
-  attr_accessor :cpu_info
-
-  # @api private
-  def initialize
-    @cpu_info = refresh
-  end
-
-  # Refresh the `cpu_info` [Hash] of the current CPU states
-  #
-  # @return [Hash] of cpu status
-  # @api public
-  def refresh
-    info = {}
-
-    # get a listing of all cpu cores
-    cpu_dirs = Dir.glob('/sys/devices/system/cpu/cpu[0-9]*')
-
-    cpu_dirs.each do |d|
-      # find the "name" of the cpu based on the sysfs dir. Eg, cpu15
-      cpu_name = File.basename d
-      cpu_idx = cpu_name.to_sym
-      info[cpu_idx] = { :name => cpu_name }
-
-      # find the numeric core_id. Eg, 15 in sysfs as
-      # /sys/devices/system/cpu/cpu3/topology/core_id but we can parse it from
-      # the path
-      core_id = cpu_name.match(/cpu(\d+)/)[1].to_i
-      info[cpu_idx][:core_id] = core_id
-
-      # is the cpu online?
-      # if a CPU is online, /sys/devices/system/cpu/cpu1/online will be 1,
-      # otherwise 0.  cpu0 appears to be special and does not have the online
-      # sysfs entry on any of the systems I inspected. I suspect that it might
-      # get this attribute if CONFIG_BOOTPARAM_HOTPLUG_CPU0 is enabled per
-      # https://www.kernel.org/doc/Documentation/cpu-hotplug.txt
-      path = File.join(d, 'online')
-      online = false
-      if File.exist?(path)
-        online = to_bool(File.read(path).chomp)
-      elsif core_id == 0
-        # cpu0 gets a special pass if the online attr is missing
-        online = true
-      end
-      info[cpu_idx][:online] = online
-
-      next unless online
-
-      # does the cpu have any [SMT] siblings?
-      # The attr /sys/devices/system/cpu/cpu6/topology/thread_siblings_list
-      # will list all siblings including the cpu's own core_id This attr is not
-      # present if the cpu is offline This attr is not present under EL5.x
-      # (2.6.18-164.el5PAE) on the one system I inspected that appears to have
-      # HT disabled in the bios (/proc/cpuinfo shows the ht cpu flag but
-      # there's no siblings list)
-      path = File.join(d, 'topology/thread_siblings_list')
-      if File.exist?(path)
-        sibs = File.read(path).chomp.split(',')
-        # convert core_id(s) to be numeric
-        sibs.map! {|s| s.to_i }
-        # remove the cpu's core_id from the list
-        sibs = sibs - [ core_id ]
-        unless sibs.empty?
-          info[cpu_idx][:thread_siblings_list] = sibs
+require 'hyperctl'
+
+module Hyperctl
+  class Sysfs
+    attr_accessor :cpu_info
+
+    # @api private
+    def initialize
+      @cpu_info = refresh
+    end
+
+    # Refresh the `cpu_info` [Hash] of the current CPU states
+    #
+    # @return [Hash] of cpu status
+    # @api public
+    def refresh
+      info = {}
+
+      # get a listing of all cpu cores
+      cpu_dirs = Dir.glob('/sys/devices/system/cpu/cpu[0-9]*')
+
+      cpu_dirs.each do |d|
+        # find the "name" of the cpu based on the sysfs dir. Eg, cpu15
+        cpu_name = File.basename d
+        cpu_idx = cpu_name.to_sym
+        info[cpu_idx] = { :name => cpu_name }
+
+        # find the numeric core_id. Eg, 15 in sysfs as
+        # /sys/devices/system/cpu/cpu3/topology/core_id but we can parse it from
+        # the path
+        core_id = cpu_name.match(/cpu(\d+)/)[1].to_i
+        info[cpu_idx][:core_id] = core_id
+
+        # is the cpu online?
+        # if a CPU is online, /sys/devices/system/cpu/cpu1/online will be 1,
+        # otherwise 0.  cpu0 appears to be special and does not have the online
+        # sysfs entry on any of the systems I inspected. I suspect that it might
+        # get this attribute if CONFIG_BOOTPARAM_HOTPLUG_CPU0 is enabled per
+        # https://www.kernel.org/doc/Documentation/cpu-hotplug.txt
+        path = File.join(d, 'online')
+        online = false
+        if File.exist?(path)
+          online = to_bool(File.read(path).chomp)
+        elsif core_id == 0
+          # cpu0 gets a special pass if the online attr is missing
+          online = true
+        end
+        info[cpu_idx][:online] = online
+
+        next unless online
+
+        # does the cpu have any [SMT] siblings?
+        # The attr /sys/devices/system/cpu/cpu6/topology/thread_siblings_list
+        # will list all siblings including the cpu's own core_id This attr is not
+        # present if the cpu is offline This attr is not present under EL5.x
+        # (2.6.18-164.el5PAE) on the one system I inspected that appears to have
+        # HT disabled in the bios (/proc/cpuinfo shows the ht cpu flag but
+        # there's no siblings list)
+        path = File.join(d, 'topology/thread_siblings_list')
+        if File.exist?(path)
+          sibs = File.read(path).chomp.split(',')
+          # convert core_id(s) to be numeric
+          sibs.map! {|s| s.to_i }
+          # remove the cpu's core_id from the list
+          sibs = sibs - [ core_id ]
+          unless sibs.empty?
+            info[cpu_idx][:thread_siblings_list] = sibs
+          end
         end
       end
+
+      @cpu_info = info
     end
 
-    @cpu_info = info
-  end
-
-  # List of all CPUs in system by numeric core id
-  #
-  # @return [Array<Integer>] of core ids
-  # @api public
-  def cores
-    cores = []
-    cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
-      cores << cpu_info[k][:core_id]
+    # List of all CPUs in system by numeric core id
+    #
+    # @return [Array<Integer>] of core ids
+    # @api public
+    def cores
+      cores = []
+      cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
+        cores << cpu_info[k][:core_id]
+      end
+
+      return cores
     end
 
-    return cores
-  end
-
-  # List of online CPUs in system by numeric core id
-  #
-  # @return [Array<Integer>] of core ids
-  # @api public
-  def online_cores
-    cores = []
-    cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
-      core_id = cpu_info[k][:core_id]
-      if cpu_info[k][:online] == true
-        cores << core_id
+    # List of online CPUs in system by numeric core id
+    #
+    # @return [Array<Integer>] of core ids
+    # @api public
+    def online_cores
+      cores = []
+      cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
+        core_id = cpu_info[k][:core_id]
+        if cpu_info[k][:online] == true
+          cores << core_id
+        end
       end
+
+      return cores
     end
 
-    return cores
-  end
-
-  # List of offline CPUs in system by numeric core id
-  #
-  # @return [Array<Integer>] of core ids
-  # @api public
-  def offline_cores
-    cores = []
-    cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
-      core_id = cpu_info[k][:core_id]
-      if cpu_info[k][:online] == false
-        cores << core_id
+    # List of offline CPUs in system by numeric core id
+    #
+    # @return [Array<Integer>] of core ids
+    # @api public
+    def offline_cores
+      cores = []
+      cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
+        core_id = cpu_info[k][:core_id]
+        if cpu_info[k][:online] == false
+          cores << core_id
+        end
       end
+
+      return cores
     end
 
-    return cores
-  end
-
-  # List of sibling (aka hyperthread/SMT) CPUs in system by numeric core id
-  #
-  # @return [Array<Integer>] of core ids
-  # @api public
-  def sibling_cores
-    cores = []
-    checked_cores = []
-    cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
-      cpu = cpu_info[k]
-      checked_cores << cpu[:core_id]
-
-      if cpu.has_key?(:thread_siblings_list)
-        (cpu[:thread_siblings_list] - checked_cores).each do |core_id|
-          # check to see if the core is already disabled
-          # XXX this probably isn't nessicary as a disabled core appears to #
-          # never be listed as a sibiling
-          if cpu_info[k][:online] == true
-            cores << core_id
+    # List of sibling (aka hyperthread/SMT) CPUs in system by numeric core id
+    #
+    # @return [Array<Integer>] of core ids
+    # @api public
+    def sibling_cores
+      cores = []
+      checked_cores = []
+      cpu_info.each_key.sort_by {|k| cpu_info[k][:core_id] }.each do |k|
+        cpu = cpu_info[k]
+        checked_cores << cpu[:core_id]
+
+        if cpu.has_key?(:thread_siblings_list)
+          (cpu[:thread_siblings_list] - checked_cores).each do |core_id|
+            # check to see if the core is already disabled
+            # XXX this probably isn't nessicary as a disabled core appears to #
+            # never be listed as a sibiling
+            if cpu_info[k][:online] == true
+              cores << core_id
+            end
           end
         end
       end
+
+      return cores
+    end
+
+    # Are all phyical/hyperthread/SMT/sibling cores enabled?
+    #
+    # @return [Bool] of status
+    # @api public
+    def all_cores_enabled?
+      cores.count == online_cores.count
+    end
+
+    # Are all hyperthread/SMT/sibling cores Disabled?
+    #
+    # @return [Bool] of status
+    # @api public
+    def all_siblings_disabled?
+      sibling_cores.empty?
+    end
+
+    # Enable a CPU by numeric core id
+    #
+    # @param core_id [Integer]
+    # @api public
+    def self.enable_core(core_id)
+      set_core(core_id, '1')
     end
 
-    return cores
-  end
-
-  # Are all phyical/hyperthread/SMT/sibling cores enabled?
-  #
-  # @return [Bool] of status
-  # @api public
-  def all_cores_enabled?
-    cores.count == online_cores.count
-  end
-
-  # Are all hyperthread/SMT/sibling cores Disabled?
-  #
-  # @return [Bool] of status
-  # @api public
-  def all_siblings_disabled?
-    sibling_cores.empty?
-  end
-
-  # Enable a CPU by numeric core id
-  #
-  # @param core_id [Integer]
-  # @api public
-  def self.enable_core(core_id)
-    set_core(core_id, '1')
-  end
-
-  # Disable a CPU by numeric core id
-  #
-  # @param core_id [Integer]
-  # @api public
-  def self.disable_core(core_id)
-    set_core(core_id, '0')
-  end
-
-  private
-
-  def to_bool(s)
-    return true if s =~ /^1$/
-    return false
-  end
-
-  def self.set_core(core_id, state)
-    path = File.join('/sys/devices/system/cpu', "cpu#{core_id.to_s}", 'online')
-    # doesn't work in ruby 1.8.7: File.write(path, '0')
-    File.open(path, 'w') do |f|
-      f.write(state)
+    # Disable a CPU by numeric core id
+    #
+    # @param core_id [Integer]
+    # @api public
+    def self.disable_core(core_id)
+      set_core(core_id, '0')
+    end
+
+    private
+
+    def to_bool(s)
+      return true if s =~ /^1$/
+      return false
+    end
+
+    def self.set_core(core_id, state)
+      path = File.join('/sys/devices/system/cpu', "cpu#{core_id.to_s}", 'online')
+      # doesn't work in ruby 1.8.7: File.write(path, '0')
+      File.open(path, 'w') do |f|
+        f.write(state)
+      end
     end
-  end
-end # class Hyperctl::Sysfs
+  end # class Sysfs
+end # module Hyperctl

data/lib/hyperctl/version.rb

@@ -1,3 +1,3 @@
 module Hyperctl
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperctl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joshua Hoblitt