linux_stat 0.9.0 → 1.0.3

data/ext/sysconf/sysconf.c

@@ -12,55 +12,94 @@
 #endif
 
 static VALUE getTick(VALUE obj) {
-	return INT2FIX(sysconf(_SC_CLK_TCK)) ;
+	short int val = sysconf(_SC_CLK_TCK) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getChildMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_CHILD_MAX)) ;
+	long long int val = sysconf(_SC_CHILD_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getHostnameMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_HOST_NAME_MAX)) ;
+	int val = sysconf(_SC_HOST_NAME_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getLoginNameMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_LOGIN_NAME_MAX)) ;
+	int val = sysconf(_SC_LOGIN_NAME_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getOpenMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_OPEN_MAX)) ;
+	int val = sysconf(_SC_OPEN_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getPageSize(VALUE obj) {
-	return INT2FIX(sysconf(_SC_PAGESIZE)) ;
+	short int val = sysconf(_SC_PAGESIZE) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getStreamMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_STREAM_MAX)) ;
+	int val = sysconf(_SC_STREAM_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getTTYNameMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_TTY_NAME_MAX)) ;
+	int val = sysconf(_SC_TTY_NAME_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getPosixVersion(VALUE obj) {
-	return INT2FIX(sysconf(_SC_VERSION)) ;
+	int val = sysconf(_SC_VERSION) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getLineMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_LINE_MAX)) ;
+	int val = sysconf(_SC_LINE_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getExprNestMax(VALUE obj) {
-	return INT2FIX(sysconf(_SC_EXPR_NEST_MAX)) ;
+	int val = sysconf(_SC_EXPR_NEST_MAX) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getProcessorConfigured(VALUE obj) {
-	return INT2FIX(sysconf(_SC_NPROCESSORS_CONF)) ;
+	short int val = sysconf(_SC_NPROCESSORS_CONF) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getProcessorOnline(VALUE obj) {
-	return INT2FIX(sysconf(_SC_NPROCESSORS_ONLN)) ;
+	short int val = sysconf(_SC_NPROCESSORS_ONLN) ;
+	if (val < 0) return Qnil ;
+
+	return INT2FIX(val) ;
 }
 
 static VALUE getUser(VALUE obj) {

data/lib/linux_stat.rb

@@ -27,6 +27,7 @@ require "linux_stat/memory"
 require "linux_stat/net"
 require "linux_stat/process"
 require "linux_stat/swap"
+require "linux_stat/usb"
 
 # Dependent Modules
 # Modules that can have reverse dependency

data/lib/linux_stat/battery.rb

@@ -1,6 +1,6 @@
 module LinuxStat
 	module Battery
-		PATH = "/sys/class/power_supply/BAT0"
+		PATH = "/sys/class/power_supply/BAT0".freeze
 
 		class << self
 			##
@@ -34,8 +34,10 @@ module LinuxStat
 			#
 			# If the battery is not present or the information isn't available it will return an empty String.
 			def model
-				return ''.freeze unless model_readable?
-				IO.read(File.join(PATH, 'model_name')).tap(&:strip!)
+				@@mn_file = File.join(PATH, 'model_name')
+				return ''.freeze unless File.readable?(@@mn_file)
+
+				IO.read(@@mn_file).tap(&:strip!)
 			end
 
 			##
@@ -43,8 +45,9 @@ module LinuxStat
 			#
 			# If the battery is not present or the information is not available, it will return an empty String.
 			def manufacturer
+				@@manufacturer_file ||= File.join(PATH, 'manufacturer')
 				return ''.freeze unless manufacturer_readable?
-				IO.read(File.join(PATH, 'manufacturer')).tap(&:strip!)
+				IO.read(@@manufacturer_file).tap(&:strip!)
 			end
 
 			##
@@ -52,8 +55,9 @@ module LinuxStat
 			#
 			# If the battery is not present or the information is not available, it will return an empty String.
 			def technology
+				@@technology_file ||= File.join(PATH, 'technology')
 				return ''.freeze unless tech_readable?
-				IO.read(File.join(PATH, 'technology')).tap(&:strip!)
+				IO.read(@@technology_file).tap(&:strip!)
 			end
 
 			##
@@ -62,8 +66,9 @@ module LinuxStat
 			#
 			# If the battery is not present or the information is not available, it will return an empty frozen String.
 			def status
+				@@status_file ||= File.join(PATH, 'status'.freeze)
 				return ''.freeze unless status_readable?
-				IO.read(File.join(PATH, 'status')).tap(&:strip!)
+				IO.read(@@status_file).tap(&:strip!)
 			end
 
 			##
@@ -81,7 +86,7 @@ module LinuxStat
 			# If the battery is not present or the information is not available, it will return nil.
 			def discharging?
 				return nil if status.empty?
-				status.downcase == 'discharging'
+				status.downcase == 'discharging'.freeze
 			end
 
 			##
@@ -90,7 +95,7 @@ module LinuxStat
 			# If the battery is not present or the information is not available, it will return nil.
 			def full?
 				return nil if status.empty?
-				status.downcase == 'full'
+				status.downcase == 'full'.freeze
 			end
 
 			##
@@ -111,6 +116,47 @@ module LinuxStat
 				percentage > 100 ? 100.0 : percentage < 0 ? 0.0 : percentage
 			end
 
+			##
+			# Returns the charge full design WH of the battery as Integer
+			# However if the info isn't available or there's no BAT0 in the system, this will return nil
+			def charge_full_design_wh
+					# voltage min design
+					@@vmd_f ||= File.join(PATH, 'voltage_min_design'.freeze)
+					v_m_d = File.readable?(@@vmd_f) ? IO.read(@@vmd_f).to_i : nil
+
+					# charge full design
+					@@cfd_f ||= File.join(PATH, 'charge_full_design'.freeze)
+					c_f_d = File.readable?(@@cfd_f) ? IO.read(@@cfd_f).to_i : nil
+
+					if v_m_d && c_f_d
+						v_m_d.fdiv(1_000_000).*(c_f_d.fdiv(1_000_000)).round(2)
+					else
+						nil
+					end
+			end
+
+			##
+			# Returns the charge full WH of the battery as Integer
+			# However if the info isn't available or there's no BAT0 in the system, this will return nil
+			def charge_full_wh
+					# voltage min design
+					@@vmd_f ||= File.join(PATH, 'voltage_min_design'.freeze)
+					v_m_d = File.readable?(@@vmd_f) ? IO.read(@@vmd_f).to_i : nil
+
+					# charge full
+					@@cf_f ||= File.join(PATH, 'charge_full'.freeze)
+					c_f = File.readable?(@@cf_f) ? IO.read(@@cf_f).to_i : nil
+
+					if v_m_d && c_f
+						v_m_d.fdiv(1_000_000).*(c_f.fdiv(1_000_000)).round(2)
+					else
+						nil
+					end
+			end
+
+			##
+			# Returns the voltage of the battery as Integer
+			# However if the info isn't available or there's no BAT0 in the system, this will return nil
 			def voltage_now
 				@@voltage_file ||= File.join(PATH, 'voltage_now'.freeze)
 				@@voltage_readable ||= File.readable?(@@voltage_file)
@@ -119,11 +165,120 @@ module LinuxStat
 				IO.read(@@voltage_file, 16).to_f.fdiv(1000000)
 			end
 
-			private
-			def model_readable?
-				@@model_readable ||= File.readable?(File.join(PATH, 'model_name'))
+			##
+			# A linux system can have multiple batteries. This method attempts to
+			# find all of them and return a Hash based on the availibility of the
+			# information.
+			#
+			# This method is somewhat slower than other Battery module singleton methods.
+			# Because it does various checks and opens various files from /sys/
+			#
+			# For example, a sample output can be like this (taken on a test system):
+			#
+			#    LinuxStat::Battery.devices_stat
+			#    => {:AC=>{:type=>"Mains", :online=>1}, :BAT0=>{:model=>"DELL CYMGM77", :manufacturer=>"Samsung SDI", :type=>"Battery", :status=>"Full", :capacity=>100, :voltage_min_design=>11.4, :charge_full_design=>3.684, :charge_full_design_wh=>42.0, :voltage_now=>12.558, :charge_now=>2.087, :charge_now_wh=>26.21, :charge_full_wh=>23.79, :charge_percentage=>100.0}, :hidpp_battery_0=>{:model=>"Wireless Keyboard", :manufacturer=>"Logitech", :type=>"Battery", :status=>"Discharging", :online=>1}}
+			#
+			# If you need info about lots of batteries, use this method.
+			# If the informations are not available, it will return empty Hash for each devices.
+			# If the system has no batteries, it will return an empty Hash.
+			def devices_stat
+				h = {}
+				Dir["/sys/class/power_supply/*/".freeze].tap(&:sort!).each do |x|
+					# model name
+					mn_file = File.join(x, 'model_name'.freeze).freeze
+					model_name = File.readable?(mn_file) ? IO.read(mn_file).strip : nil
+
+					# manufacturer
+					m_f = File.join(x, 'manufacturer'.freeze).freeze
+					manufacturer = File.readable?(m_f) ? IO.read(m_f).strip : nil
+
+					# type
+					t_f = File.join(x, 'type'.freeze).freeze
+					type = File.readable?(t_f) ? IO.read(t_f).strip : nil
+
+					# capacity
+					c_file = File.join(x, 'capacity'.freeze).freeze
+					capacity = File.readable?(c_file) ? IO.read(c_file).to_i : nil
+
+					# voltage now
+					vn_f = File.join(x, 'voltage_now'.freeze).freeze
+					voltage_now = File.readable?(vn_f) ? IO.read(vn_f).to_i.fdiv(1_000_000) : nil
+
+					# charge now
+					cn_f = File.join(x, 'charge_now'.freeze).freeze
+					charge_now = File.readable?(cn_f) ? IO.read(cn_f).to_i.fdiv(1_000_000) : nil
+
+					# voltage min design
+					vmd_f = File.join(x, 'voltage_min_design'.freeze).freeze
+					v_m_d = File.readable?(vmd_f) ? IO.read(vmd_f).to_i.fdiv(1_000_000) : nil
+
+					# charge full design
+					cfd_f = File.join(x, 'charge_full_design'.freeze).freeze
+					c_f_d = File.readable?(cfd_f) ? IO.read(cfd_f).to_i.fdiv(1_000_000) : nil
+
+					# charge full
+					cf_f = File.join(x, 'charge_full'.freeze).freeze
+					charge_full = File.readable?(cf_f) ? IO.read(cf_f).to_i.fdiv(1_000_000) : nil
+
+					# status
+					s_f = File.join(x, 'status'.freeze).freeze
+					status = File.readable?(s_f) ? IO.read(s_f).strip : nil
+
+					# online
+					o_f = File.join(x, 'online'.freeze).freeze
+					online = File.readable?(o_f) ? IO.read(o_f).to_i : nil
+
+					charge_percentage = if charge_now && charge_full
+						charge_now.*(100).fdiv(charge_full).round(2)
+					else
+						nil
+					end
+
+					# full_charge_design (WH)
+					c_f_d_wh =  if c_f_d && v_m_d
+						v_m_d.*(c_f_d).round(2)
+					else
+						nil
+					end
+
+					c_n_wh = if voltage_now && charge_now
+						voltage_now.*(charge_now).round(2)
+					else
+						nil
+					end
+
+					c_f_wh = if v_m_d && charge_full
+						v_m_d.*(charge_full).round(2)
+					else
+						nil
+					end
+
+					ret = {}
+					ret[:model] = model_name if model_name
+					ret[:manufacturer] = manufacturer if manufacturer
+					ret[:type] = type if type
+
+					ret[:status] = status if status
+					ret[:online] = online if online
+					ret[:capacity] = capacity if capacity
+
+					ret[:voltage_min_design] = v_m_d if v_m_d
+					ret[:charge_full_design] = c_f_d if c_f_d
+					ret[:charge_full_design_wh] = c_f_d_wh if c_f_d_wh
+
+					ret[:voltage_now] = voltage_now if voltage_now
+					ret[:charge_now] = charge_now if charge_now
+
+					ret[:charge_now_wh] = c_n_wh if c_n_wh
+					ret[:charge_full_wh] = c_f_wh if c_f_wh
+					ret[:charge_percentage] = charge_percentage if charge_percentage
+
+					h.merge!(File.split(x)[-1].to_sym => ret)
+				end
+				h
 			end
 
+			private
 			def manufacturer_readable?
 				@@manufacturer_readable ||= File.readable?(File.join(PATH, 'manufacturer'))
 			end

data/lib/linux_stat/cpu.rb

@@ -63,9 +63,9 @@ module LinuxStat
 			def total_usage(sleep = ticks_to_ms_t5)
 				return nil unless stat?
 
-				data = IO.foreach('/proc/stat').first.split.tap(&:shift).map!(&:to_f)
+				data = IO.foreach('/proc/stat'.freeze).first.split.tap(&:shift).map!(&:to_f)
 				sleep(sleep)
-				data2 = IO.foreach('/proc/stat').first.split.tap(&:shift).map!(&:to_f)
+				data2 = IO.foreach('/proc/stat'.freeze).first.split.tap(&:shift).map!(&:to_f)
 
 				user, nice, sys, idle, iowait, irq, softirq, steal = *data
 				user2, nice2, sys2, idle2, iowait2, irq2, softirq2, steal2 = *data2
@@ -82,7 +82,7 @@ module LinuxStat
 			#
 			# It returns an Integer.
 			#
-			# If the information isn't available, it will return an empty Array.
+			# If the information isn't available, it will return nil.
 			def count
 				@@cpu_count ||= LinuxStat::Sysconf.processor_configured
 			end
@@ -90,21 +90,65 @@ module LinuxStat
 			##
 			# Returns the total number of CPU online in the sysetm.
 			#
+			# It first reads /proc/stat, if that fails, it will
+			# read /sys/devices/system/cpu/online,
+			# if that fails it will open /proc/cpuinfo.
+			# If neither of the procedures work, it will get the
+			# LinuxStat::Sysconf.processor_online
+			#
 			# It opens /sys/devices/system/cpu/offline and
 			# performs various job to get one Ruby array.
 			#
 			# If the information isn't available, it will return an empty Array.
+			def count_online
+				@@cpuinfo_file ||= '/proc/cpuinfo'.freeze
+				@@cpuinfo_readable ||= File.readable?(@@cpuinfo_file)
+
+				@@stat_file ||= '/proc/stat'.freeze
+
+				# Not much slow, not blazing fast, somewhat reliable
+				get_online = online
+
+				if !get_online.empty?
+					get_online.length
+				elsif @@cpuinfo_readable
+					# Way slower but reliable!
+					IO.readlines(@@cpuinfo_file).count { |x| x.strip[/\Aprocessor.*\d*\z/] }
+				else
+					# Way faster but absolutely unrealiable!
+					LinuxStat::Sysconf.processor_online
+				end
+			end
+
+			##
+			# Returns the total number of CPU online in the sysetm.
+			#
+			# It will read /proc/stat to get the info.
+			#
+			# If the info isn't available, it reads /sys/devices/system/cpu/onfline and
+			# performs various job to get one Ruby array.
+			#
+			# If the information isn't available, it will return an empty Array.
 			def online
 				@@online_file ||= '/sys/devices/system/cpu/online'.freeze
 				@@online_readable ||= File.readable?(@@online_file)
-				return [] unless @@online_readable
+
+				@@stat_file ||= '/proc/stat'.freeze
 
 				ret = []
-				IO.read(@@online_file).split(?,.freeze).each { |x|
-					x.strip!
-					c = x.split(?-.freeze).map(&:to_i)
-					ret.concat(c.length == 2 ? Range.new(*c).to_a : c)
-				}
+
+				if stat?
+					IO.readlines(@@stat_file).map { |x|
+						v = x.strip[/\Acpu\d*/] &.[](/\d/)
+						ret << v.to_i if v
+					}
+				elsif @@online_readable
+					IO.read(@@online_file).split(?,.freeze).each { |x|
+						x.strip!
+						c = x.split(?-.freeze).map(&:to_i)
+						ret.concat(c.length == 2 ? Range.new(*c).to_a : c)
+					}
+				end
 
 				ret
 			end
@@ -269,7 +313,8 @@ module LinuxStat
 			# ticks to ms times 5
 			# If the ticks is 100, it will return 0.05
 			def ticks_to_ms_t5
-				@@ms_t5 ||= 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5
+				@@sc_clk_tck ||= LinuxStat::Sysconf.sc_clk_tck.to_i
+				@@ms_t5 ||= 1.0 / (@@sc_clk_tck < 1 ? 100 : @@sc_clk_tck) * 5
 			end
 
 			def cpus