linux_stat 1.2.3 → 1.6.0

data/lib/linux_stat/battery.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various battery related information of the current system.
+
 	module Battery
 		PATH = "/sys/class/power_supply/BAT0".freeze
 

data/lib/linux_stat/bios.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various BIOS related information of the current system.
+
 	module BIOS
 		class << self
 			##

data/lib/linux_stat/cpu.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various CPU related information of the current system.
+
 	module CPU
 		class << self
 			##

data/lib/linux_stat/filesystem.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Filesystem related information of the current system.
+
 	module Filesystem
 		class << self
 			##

data/lib/linux_stat/kernel.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Kernel related information of the current system.
+
 	module Kernel
 		class << self
 			##

data/lib/linux_stat/memory.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Memory related information of the current system.
+
 	module Memory
 		class << self
 			##
@@ -33,13 +35,23 @@ module LinuxStat
 			end
 
 			##
-			# Returns the total memory details reported by /proc/meminfo.
+			# Returns the total memory reported by LS::Sysinfo.totalram()
 			# The value is in Kilobyte.
 			#
 			# It retuns an Integer but if the info is not available, it will return nil.
 			def total
-				return nil unless meminfo?
-				IO.foreach('/proc/meminfo'.freeze).first.split[1].to_i
+				v = LinuxStat::Sysinfo.totalram
+				v ? v.fdiv(1024).to_i : nil
+			end
+
+			##
+			# Returns the free memory reported by LS::Sysinfo.freeram()
+			# The value is in Kilobyte.
+			#
+			# It retuns an Integer but if the info is not available, it will return nil.
+			def free
+				v = LinuxStat::Sysinfo.freeram
+				v ? v.fdiv(1024).to_i : nil
 			end
 
 			##

data/lib/linux_stat/mounts.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Mounted device related information of the current system.
+
 	module Mounts
 		class << self
 			##

data/lib/linux_stat/net.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Net related information of the current system.
+
 	module Net
 		class << self
 			DEV = '/proc/net/dev'.freeze

data/lib/linux_stat/os.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various OS related information of the current system.
+
 	module OS
 		class << self
 			##
@@ -138,6 +140,8 @@ module LinuxStat
 			#
 			#    => {:hour=>10, :minute=>34, :second=>12.59}
 			#
+			# Using uptime is 10x slower than using uptime_i
+			#
 			# If the stat isn't available, an empty hash is returned.
 			def uptime
 				return {} unless uptime_readable?
@@ -156,6 +160,56 @@ module LinuxStat
 				}.freeze
 			end
 
+			##
+			# Returns Float uptime of the system reported by /proc/uptime
+			#    LinuxStat::OS.uptime_f
+			#
+			#    => 28956.34
+			#
+			# The value is generally rounded to 2 decimal places.
+			#
+			# Using uptime_f is 10x slower than using uptime_i
+			#
+			# If the stat isn't available, nil is returned.
+			def uptime_f
+				return nil unless uptime_readable?
+				IO.foreach('/proc/uptime'.freeze, ' ').next.to_f
+			end
+
+			##
+			# Returns uptime of the system reported by LinuxStat::Sysinfo.uptime()
+			#    LinuxStat::OS.uptime_i
+			#
+			#    => 28956
+			#
+			# If the stat isn't available, nil is returned.
+			def uptime_i
+				LinuxStat::Sysinfo.uptime
+			end
+
+			##
+			# The first three fields in this file are load average
+              		# figures giving the number of jobs in the run queue (state R)
+			# or waiting for disk I/O (state D) averaged over 1, 5,
+			# and 15 minutes.  They are the same as the load average
+			# numbers given by uptime(1) and other programs.
+			# https://man7.org/linux/man-pages/man5/procfs.5.html
+			#
+			# The return type is an Hash containing the values
+			# that maps to 1, 5, and 15.
+			# This method calls LinuxStat::Sysinfo.loads() directly.
+			#
+			# However, if the info isn't available, it will return nil as values.
+			def loadavg
+				loads = LinuxStat::Sysinfo.loads
+
+				{
+					1 => loads[0],
+					5 => loads[1],
+					15 => loads[2]
+				}
+			end
+
 			alias distrib_version version
 
 			private

data/lib/linux_stat/pci.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various PCI device related information of the current system.
+
 	module PCI
 		class << self
 			##

data/lib/linux_stat/prettify_bytes.rb

@@ -1,4 +1,11 @@
 module LinuxStat
+	# Helps you convert bytes to a unit like:
+	#
+	# 1. kilobyte, megabyte, gigabyte, terabyte, petabyte, exabyte, zettabyte, yottabyte
+	# 2. kibibyte, mebibyte, gibibyte, tebibyte, pebibyte, exbibyte, zebibyte, yobibyte
+	# 3. kB, MB, GB, TB, PB, EB, ZB, YB
+	# 4. kiB, MiB, GiB, TiB, PiB, EiB, ZiB, YiB
+
 	module PrettifyBytes
 		class << self
 			##
@@ -16,13 +23,13 @@ module LinuxStat
 			# LinuxStat::PrettifyBytes.convert_decimal(1024 ** 3)
 			#
 			# => "1.07 gigabytes"
-			def convert_decimal(n)
+			def convert_decimal(n, precision: 2)
 				@@d_units ||= %W(#{''} kilo mega giga tera peta exa zetta)
 					.map.with_index { |x, i| [x, 1000.**(i + 1)] }
 				unit = @@d_units.find { |x| n < x[1] } || ['yotta'.freeze, 10 ** 27]
 
 				converted = n.fdiv(unit[1] / 1000).round(2)
-				"#{pad_left(converted)} #{unit[0]}byte#{?s.freeze if converted != 1}"
+				"#{pad_left(converted, precision)} #{unit[0]}byte#{?s.freeze if converted != 1}"
 			end
 
 			# Converts a number to binary byte units and outputs with the IEC prefix
@@ -39,13 +46,13 @@ module LinuxStat
 			# LinuxStat::PrettifyBytes.convert_binary(1024 ** 3)
 			#
 			# => "1.0 gibibyte"
-			def convert_binary(n)
+			def convert_binary(n, precision: 2)
 				@@b_units ||= %W(#{''} kibi mebi gibi tebi pebi exbi zebi)
 					.map.with_index { |x, i| [x, 1024.**(i + 1)] }
 				unit = @@b_units.find { |x| n < x[1] } || ['yobi'.freeze, 10 ** 27]
 
 				converted = n.fdiv(unit[1] / 1024).round(2)
-				"#{pad_left(converted)} #{unit[0]}byte#{?s.freeze if converted != 1}"
+				"#{pad_left(converted, precision)} #{unit[0]}byte#{?s.freeze if converted != 1}"
 			end
 
 			# Converts a number to decimal byte units
@@ -62,13 +69,13 @@ module LinuxStat
 			# LinuxStat::PrettifyBytes.convert_short_decimal(1024 ** 3)
 			#
 			# => "1.07 GB"
-			def convert_short_decimal(n)
+			def convert_short_decimal(n, precision: 2)
 				@@sd_units ||= %W(#{''} k M G T P E Z)
 					.map.with_index { |x, i| [x, 1000.**(i + 1)] }
 				unit = @@sd_units.find { |x| n < x[1] } || [?Y.freeze, 10 ** 27]
 
 				converted = n.fdiv(unit[1] / 1000).round(2)
-				"#{pad_left(converted)} #{unit[0]}B"
+				"#{pad_left(converted, precision)} #{unit[0]}B"
 			end
 
 			##
@@ -87,15 +94,15 @@ module LinuxStat
 			# LinuxStat::PrettifyBytes.convert_short_binary(1024 ** 3)
 			#
 			# => "1.0 GiB"
-			def convert_short_binary(n)
-				return "#{n} B" if n < 1024
+			def convert_short_binary(n, precision: 2)
+				return "#{pad_left(n, precision)} B" if n < 1024
 
 				@@sb_units ||= %W(#{''} K M G T P E Z)
 					.map.with_index { |x, i| [x, 1024.**(i + 1)] }
 				unit = @@sb_units.find { |x| n < x[1] } || [?Y.freeze, 1024 ** 9]
 
 				converted = n.fdiv(unit[1] / 1024).round(2)
-				"#{pad_left(converted)} #{unit[0]}iB"
+				"#{pad_left(converted, precision)} #{unit[0]}iB"
 			end
 
 			private

data/lib/linux_stat/process.rb

@@ -1,4 +1,7 @@
 module LinuxStat
+	# Shows various information about a process that is either
+	# running, sleeping, idle or a zombie.
+
 	module Process
 		class << self
 			##
@@ -28,7 +31,8 @@ module LinuxStat
 			end
 
 			##
-			# Returns all the id of processes mapped with their names as a Hash.
+			# Returns all the id of processes mapped with their executable names (comm) as a Hash.
+			# The names can be truncated to TASK_COMM_LEN or (16 - 1 = 15) places.
 			def names
 				h, i = {}, -1
 
@@ -39,7 +43,30 @@ module LinuxStat
 					x = l[i]
 
 					begin
-						h.merge!( x => IO.foreach("/proc/#{x}/status").first.split[1])
+						h.merge!( x => IO.read("/proc/#{x}/comm").strip)
+					rescue StandardError
+					end
+				end
+				h
+			end
+
+			##
+			# Returns all the id of processes mapped with their cmdline info as a Hash.
+			# The cmdlines aren't usually truncated like names, but they can contain
+			# arguments with the command.
+			def cmdlines
+				h, i = {}, -1
+
+				l = list
+				count = l.length
+
+				while(i += 1) < count
+					x = l[i]
+
+					begin
+						cmdlines = IO.read("/proc/#{x}/cmdline").strip
+						cmdlines.gsub!(?\u0000.freeze, ?\s.freeze)
+						h.merge!( x => cmdlines)
 					rescue StandardError
 					end
 				end
@@ -59,11 +86,15 @@ module LinuxStat
 
 					begin
 						h.merge!(x =>
-							case IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0]
+							case IO.read("/proc/#{x}/stat").split(/(\(.*\))/)[-1][/\s.+?/].strip
 								when ?S.freeze then :sleeping
 								when ?I.freeze then :idle
 								when ?Z.freeze then :zombie
 								when ?R.freeze then :running
+								when ?T.freeze then :stopped
+								when ?X.freeze then :dead
+								when ?D.freeze then :sleeping
+								when ?t.freeze then :stopped
 								else :unknown
 							end
 						)
@@ -80,9 +111,9 @@ module LinuxStat
 			def sleeping
 				list.select { |x|
 					begin
-						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?S.freeze
+						IO.read("/proc/#{x}/stat").split(/(\(.*\))/)[-1][/\s.+?/].strip == ?S.freeze
 					rescue StandardError
-						nil
+						false
 					end
 				}
 			end
@@ -93,9 +124,9 @@ module LinuxStat
 			def idle
 				list.select { |x|
 					begin
-						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?I.freeze
+						IO.read("/proc/#{x}/stat").split(/(\(.*\))/)[-1][/\s.+?/].strip == ?I.freeze
 					rescue StandardError
-						nil
+						false
 					end
 				}
 			end
@@ -106,9 +137,9 @@ module LinuxStat
 			def zombie
 				list.select { |x|
 					begin
-						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?Z.freeze
+						IO.read("/proc/#{x}/stat").split(/(\(.*\))/)[-1][/\s.+?/].strip == ?Z.freeze
 					rescue StandardError
-						nil
+						false
 					end
 				}
 			end
@@ -119,9 +150,23 @@ module LinuxStat
 			def running
 				list.select { |x|
 					begin
-						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?R.freeze
+						IO.read("/proc/#{x}/stat").split(/(\(.*\))/)[-1][/\s.+?/].strip == ?R.freeze
+					rescue StandardError
+						false
+					end
+				}
+			end
+
+			##
+			# Returns all the id of processes that are stopped.
+			# The return type is an Array of Integers.
+			def stopped
+				list.select { |x|
+					begin
+						v = IO.read("/proc/#{x}/stat").split(/(\(.*\))/)[-1][/\s.+?/].strip
+						v == ?T.freeze || v == ?t.freeze
 					rescue StandardError
-						nil
+						false
 					end
 				}
 			end

data/lib/linux_stat/process_info.rb

@@ -1,4 +1,11 @@
 module LinuxStat
+	# Shows various information about a process that is either
+	# running, sleeping, idle or a zombie.
+	# Most methods can take a PID, but some uses polling to calculate
+	# something, they can accept options instead of arguments.
+	# Consult the documentation on the specific methods
+	# for more details on that.
+
 	module ProcessInfo
 		class << self
 			##
@@ -62,6 +69,8 @@ module LinuxStat
 
 			##
 			# = command_name(pid = $$)
+			# Not to be confused with process_name
+			# It just splits the cmdline to show the command name
 			#
 			# Where pid is the process ID.
 			#
@@ -77,12 +86,40 @@ module LinuxStat
 			# If the info isn't available it will return an empty frozen String.
 			def command_name(pid = $$)
 				# Do note that the /proc/ppid/comm may not contain the full name
-				file = "/proc/#{pid}/cmdline".freeze
-				return ''.freeze unless File.readable?(file)
+				# It's limited by TASK_COMM_LEN (16) characters
+				c = cmdline(pid).split[0]
+				return ''.freeze unless c
+				File.split(c)[-1]
+			end
 
-				_cmdline = IO.read(file)
-				_cmdline.gsub!(?\u0000, ?\s)
-				File.split(_cmdline.tap(&:strip!).split[0])[-1]
+			##
+			# = process_name(pid = $$)
+			# It shows the filename of the command
+			# Sometimes the filename is stripped
+			#
+			# Where pid is the process ID.
+			#
+			# By default it is the id of the current process ($$)
+			#
+			# It retuns the total command name of the process.
+			#
+			# The output is String. For example:
+			#    LinuxStat::ProcessInfo.process_name
+			#
+			#    "ruby"
+			#
+			# If the info isn't available it will return an empty frozen String.
+			def process_name(pid = $$)
+				file = "/proc/#{pid}/stat".freeze
+				return command_name unless File.readable?(file)
+
+				name = IO.read(file).split(/(\(.*\))/) &.[](1) &.[](1..-2)
+
+				if name && name.length > 0 && name.length < 15
+					name
+				else
+					command_name
+				end
 			end
 
 			##
@@ -249,8 +286,11 @@ module LinuxStat
 				ticks = get_ticks
 
 				return {} unless File.readable?(file)
-				utime, stime, starttime = IO.read(file)
-					.split.values_at(13, 14, 21).map(&:to_f)
+
+				stat = IO.read(file).split(/(\(.*\))/)[-1] &.split
+				return {} unless stat
+
+				utime, stime, starttime = *stat.values_at(11, 12, 19).map(&:to_f)
 
 				uptime = IO.read('/proc/uptime'.freeze).to_f * ticks
 
@@ -260,9 +300,12 @@ module LinuxStat
 				sleep(sleep)
 
 				return {} unless File.readable?(file)
-				stat = IO.read(file).split
 
-				utime2, stime2, starttime2 = stat.values_at(13, 14, 21).map(&:to_f)
+				stat = IO.read(file).split(/(\(.*\))/)[-1] &.split
+				return {} unless stat
+
+				utime2, stime2, starttime2 = *stat.values_at(11, 12, 19).map(&:to_f)
+
 				uptime = IO.read('/proc/uptime'.freeze).to_f * ticks
 
 				total_time2 = utime2 + stime2
@@ -273,8 +316,8 @@ module LinuxStat
 
 				{
 					cpu_usage: cpu_u > 100 ? 100.0 : cpu_u.round(2),
-					threads: stat[19].to_i,
-					last_executed_cpu: stat[38].to_i
+					threads: stat[17].to_i,
+					last_executed_cpu: stat[36].to_i
 				}
 			end
 
@@ -309,8 +352,11 @@ module LinuxStat
 				ticks = get_ticks
 
 				return nil unless File.readable?(file)
-				utime, stime, starttime = IO.read(file)
-					.split.values_at(13, 14, 21).map(&:to_f)
+
+				stat = IO.read(file).split(/(\(.*\))/)[-1] &.split
+				return nil unless stat
+
+				utime, stime, starttime = *stat.values_at(11, 12, 19).map(&:to_f)
 
 				uptime = IO.read('/proc/uptime'.freeze).to_f * ticks
 
@@ -320,9 +366,11 @@ module LinuxStat
 				sleep(sleep)
 
 				return nil unless File.readable?(file)
-				utime2, stime2, starttime2 = IO.read(file)
-					.split.values_at(13, 14, 21).map(&:to_f)
 
+				stat = IO.read(file).split(/(\(.*\))/)[-1] &.split
+				return nil unless stat
+
+				utime2, stime2, starttime2 = *stat.values_at(11, 12, 19).map(&:to_f)
 				uptime = IO.read('/proc/uptime'.freeze).to_f * ticks
 
 				total_time2 = utime2 + stime2
@@ -361,8 +409,11 @@ module LinuxStat
 				ticks = get_ticks
 
 				return nil unless File.readable?(file)
-				utime, stime, starttime = IO.read(file)
-					.split.values_at(13, 14, 21).map(&:to_f)
+
+				stat = IO.read(file).split(/(\(.*\))/)[-1] &.split
+				return nil unless stat
+
+				utime, stime, starttime = *stat.values_at(11, 12, 19).map(&:to_f)
 
 				uptime = IO.read('/proc/uptime'.freeze).to_f * ticks
 
@@ -372,8 +423,11 @@ module LinuxStat
 				sleep(sleep)
 
 				return nil unless File.readable?(file)
-				utime2, stime2, starttime2 = IO.read(file)
-					.split.values_at(13, 14, 21).map(&:to_f)
+
+				stat = IO.read(file).split(/(\(.*\))/)[-1] &.split
+				return nil unless stat
+
+				utime2, stime2, starttime2 = *stat.values_at(11, 12, 19).map(&:to_f)
 
 				uptime = IO.read('/proc/uptime'.freeze).to_f * ticks
 
@@ -409,7 +463,7 @@ module LinuxStat
 				file = "/proc/#{pid}/stat".freeze
 				return nil unless File.readable?(file)
 
-				data = IO.foreach(file, ' '.freeze).first(20)[-1]
+				data = IO.read(file).split(/(\(.*\))/)[-1] &.split &.at(17)
 				data ? data.to_i : nil
 			end
 
@@ -434,7 +488,8 @@ module LinuxStat
 				file = "/proc/#{pid}/stat".freeze
 				return nil unless File.readable?(file)
 
-				IO.read(file).split[38].to_i
+				data = IO.read(file).split(/(\(.*\))/)[-1] &.split &.at(36)
+				data ? data.to_i : nil
 			end
 
 			##
@@ -517,8 +572,11 @@ module LinuxStat
 				@@u_readable ||= File.readable?(uptime)
 				return nil unless @@u_readable && File.readable?(stat_file)
 
+				stat = IO.read(stat_file).split(/(\(.*\))/)[-1] &.split
+				return nil unless stat
+
 				u = IO.foreach(uptime, ' '.freeze).next.to_f
-				st = (IO.foreach(stat_file, ' '.freeze).first(22)[-1].to_f / get_ticks)
+				st = stat[19].to_f / get_ticks
 
 				# Getting two Time objects and dealing with floating point numbers
 				# Just to make sure the time goes monotonically
@@ -567,8 +625,11 @@ module LinuxStat
 				@@u_readable ||= File.readable?(uptime)
 				return nil unless @@u_readable && File.readable?(stat_file)
 
+				stat = IO.read(stat_file).split(/(\(.*\))/)[-1] &.split
+				return nil unless stat
+
 				IO.foreach(uptime, ' '.freeze).next.to_f
-					.-(IO.read(stat_file).split[21].to_f / get_ticks).round(2)
+					.-(stat[19].to_f / get_ticks).round(2)
 			end
 
 			##
@@ -592,7 +653,11 @@ module LinuxStat
 			def state(pid = $$)
 				file = "/proc/#{pid}/stat".freeze
 				return ''.freeze unless File.readable?(file)
-				IO.foreach(file, ' '.freeze).first(3)[-1].tap(&:rstrip!).freeze
+
+				stat = IO.read(file).split(/(\(.*\))/)[-1]
+				return '' unless stat
+
+				stat[/\s.+?/].strip
 			end
 
 			##
@@ -608,7 +673,10 @@ module LinuxStat
 				file = "/proc/#{pid}/stat"
 				return nil unless File.readable?(file)
 
-				IO.foreach(file, ' ').first(19)[-1].to_i
+				stat = IO.read(file).split(/(\(.*\))/)[-1] &.split
+				return nil unless stat
+
+				stat[16].to_i
 			end
 
 			##