linux_stat 0.5.1 → 0.6.4

data/lib/linux_stat/kernel.rb

@@ -1,16 +1,22 @@
 module LinuxStat
 	module Kernel
 		class << self
+			##
 			# Returns the Linux Kernel version.
+			#
 			# If the information isn't available, it will return a frozen empty string.
+			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def version
 				return ''.freeze if string.empty?
 				@@version ||= splitted[2]
 			end
 
+			##
 			# Returns the name of the user who built the kernel using KBUILD_FLAGS.
+			#
 			# If the information isn't available, it will return a frozen empty string.
+			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def build_user
 				@@build_user ||= string.split(/(\(.+\))/).each(&:strip!)
@@ -18,8 +24,11 @@ module LinuxStat
 					.split[0].to_s[1..-2].to_s.freeze
 			end
 
+			##
 			# Returns the compiler used to compile the Linux Kernel.
+			#
 			# If the information isn't available, it will return a frozen empty string.
+			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def compiler
 				return ''.freeze if string.empty?
@@ -37,8 +46,11 @@ module LinuxStat
 				end << compiler_version
 			end
 
+			##
 			# Returns the compiler version used to compile the Linux Kernel.
+			#
 			# If the information isn't available, it will return a frozen empty string.
+			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def compiler_version
 				@@compiler_version ||= string.split(/(\(.+?\))/).each(&:strip!)
@@ -46,20 +58,28 @@ module LinuxStat
 					.find { |x| x[/[\d.]+/] }.to_s[/[\d.]+/].to_s.freeze
 			end
 
+			##
 			# Returns the time when the kernel was compiled.
+			#
 			# The return value is a Time object.
+			#
 			# If the information isn't available, it will return nil
 			#
 			# The time will be searched in specific order.
-			# It will match any date matching any of these formats:
+			#
+			# * It will match any date matching any of these formats:
 			# 1. %b %d %H:%M:%S %z %Y
 			# 2. %d %b %Y %H:%M:%S %z
 			# 3. %Y-%m-%d
+			#
 			# Most kernels have date in them in this format.
 			#
 			# Do note that Ruby sometimes fails to work with timezones like BST for example.
+			#
 			# In such case, the timezone is unrealiable and often returns the local timezone.
+			#
 			# You have to use regexp yourself to get the proper zone.
+			#
 			# Use LinuxStat::Kernel.build_date_string to get the original string if you need that.
 			#
 			# The output is also cached  (memoized) ; as changing the value in runtime is unexpected.
@@ -91,20 +111,29 @@ module LinuxStat
 				end
 			end
 
+			##
 			# Returns the time when the kernel was compiled.
+			#
 			# The return value is a String.
+			#
 			# If the information isn't available, it will return nil
 			#
 			# The time will be searched in specific order.
-			# It will match any date matching any of these formats:
+			#
+			# * It will match any date matching any of these formats:
+			#
 			# 1. %b %d %H:%M:%S %z %Y
 			# 2. %d %b %Y %H:%M:%S %z
 			# 3. %Y-%m-%d
+			#
 			# Most kernels have date in them in this format.
 			#
 			# Do note that Ruby sometimes fails to work with timezones like BST for example.
+			#
 			# In such case, the timezone is unrealiable and often returns the local timezone.
+			#
 			# You have to use regexp yourself to get the proper zone.
+			#
 			# Use LinuxStat::Kernel.build_date_string to get the original string if you need that.
 			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
@@ -133,14 +162,19 @@ module LinuxStat
 				end
 			end
 
+			##
 			# Reads maximum 1024 bytes from /proc/version and returns the string.
+			#
 			# The output is also cached ; as changing the value in runtime is unexpected.
 			def string
 				@@string ||= File.readable?('/proc/version') ? IO.read('/proc/version', 1024).tap(&:strip!) : ''
 			end
 
+			##
 			# Returns the sc_clk_tck or the same output from command `getconf CLK_TCK`.
+			#
 			# Also, clk_tck is an alias of this method.
+			#
 			# The output is also cached ; as changing the value in runtime is unexpected.
 			def ticks
 				@@tick ||= LinuxStat::Sysconf.sc_clk_tck

data/lib/linux_stat/memory.rb

@@ -1,6 +1,7 @@
 module LinuxStat
 	module Memory
 		class << self
+			##
 			# Returns the memory details reported by /proc/meminfo. In this format:
 			#    {:total=>3836264, :used=>3097952, :available=>738312, :percent_used=>80.75, :percent_available=>19.25}
 			#
@@ -20,6 +21,7 @@ module LinuxStat
 				percent_available = total == 0 ? 0.0 : available.*(100).fdiv(total).round(2)
 
 				# We have all the methods, but each methods reads the same file
+				#
 				# So better to use the above calculation
 				{
 					total: total,
@@ -30,6 +32,7 @@ module LinuxStat
 				}
 			end
 
+			##
 			# Returns the total memory details reported by /proc/meminfo.
 			# The value is in Kilobyte.
 			#
@@ -39,6 +42,7 @@ module LinuxStat
 				IO.foreach('/proc/meminfo').first.split[1].to_i
 			end
 
+			##
 			# Returns the total memory details reported by /proc/meminfo.
 			# The value is in Kilobyte.
 			#
@@ -48,6 +52,7 @@ module LinuxStat
 				IO.foreach('/proc/meminfo').first(3)[-1].split[1].to_i
 			end
 
+			##
 			# Returns the amount of memory used reported by /proc/meminfo.
 			# The value is in Kilobyte.
 			#
@@ -58,6 +63,7 @@ module LinuxStat
 				memory[0].split[1].to_i - memory[2].split[1].to_i
 			end
 
+			##
 			# Returns the percentage of memory used reported by /proc/meminfo.
 			#
 			# It retuns an Integer but if the info is not available, it will return nil
@@ -68,6 +74,7 @@ module LinuxStat
 				total.-(memory[2].split[1].to_i).*(100).fdiv(total).round(2)
 			end
 
+			##
 			# Returns the percentage of memory used reported by /proc/meminfo.
 			#
 			# It retuns an Integer but if the info is not available,  it will return nil

data/lib/linux_stat/mounts.rb

@@ -1,7 +1,10 @@
 module LinuxStat
 	module Mounts
 		class << self
-			# Reads /proc/mounts and returns list of devices.
+			##
+			# Reads /proc/mounts and returns the output splitted with \n.
+			#
+			# In other words, it's same as running IO.readlines('/proc/mounts').each(&:strip!)
 			#
 			# It returns an Array.
 			# If the info isn't available or /proc/mounts is not readable, it will return an empty Array.
@@ -9,6 +12,16 @@ module LinuxStat
 				mounts
 			end
 
+			##
+			# Reads /proc/mounts and returns list of devices.
+			#
+			# It returns an Array.
+			# If the info isn't available or /proc/mounts is not readable, it will return an empty Array.
+			def list_devices
+				mounts.map { |x| x.split(?\s.freeze).first }
+			end
+
+			##
 			# Reads /proc/mounts and returns partition name of the device mounted at /.
 			#
 			# It returns a String.
@@ -17,6 +30,7 @@ module LinuxStat
 				find_root[0].to_s
 			end
 
+			##
 			# Reads /proc/mounts and returns the file system of the device mounted at /.
 			#
 			# It returns a String.
@@ -25,6 +39,7 @@ module LinuxStat
 				find_root[2].to_s
 			end
 
+			##
 			# Reads /proc/mounts and returns the options used for mounting /.
 			#
 			# It returns a String.
@@ -33,6 +48,7 @@ module LinuxStat
 				find_root[3].to_s
 			end
 
+			##
 			# Reads /proc/mounts and finds all tmpfs.
 			#
 			# It returns a Hash
@@ -45,6 +61,152 @@ module LinuxStat
 				ret
 			end
 
+			##
+			# mount_point(dev = root)
+			#
+			# Where device = block device.
+			#
+			# The default argument is the root block device.
+			#
+			# It helps you find the mountpoint of a block device.
+			# For example:
+			#
+			#    LinuxStat::Mounts.mount_point('/dev/sdb1')
+			#
+			#    => "/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f"
+			#
+			# The return type is String.
+			# But if the status isn't available or the device isn't mounted, it will return an empty String.
+			def mount_point(dev = root)
+				m = ''
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						if _x[0] == dev
+							m.replace(_x[1])
+							break
+						end
+					end
+				end
+				m
+			end
+
+			##
+			# list_devices_mount_point()
+			#
+			# It shows all the block devices corresponding to mount points.
+			#
+			# For example:
+			#
+			#    LinuxStat::Mounts.list_devices_mount_point
+			#
+			#    => {"proc"=>"/proc", "sys"=>"/sys", "dev"=>"/dev", "run"=>"/run", "/dev/sda2"=>"/", "securityfs"=>"/sys/kernel/security", "tmpfs"=>"/run/user/1000", "devpts"=>"/dev/pts", "cgroup2"=>"/sys/fs/cgroup/unified", "cgroup"=>"/sys/fs/cgroup/perf_event", "pstore"=>"/sys/fs/pstore", "none"=>"/sys/fs/bpf", "systemd-1"=>"/proc/sys/fs/binfmt_misc", "debugfs"=>"/sys/kernel/debug", "mqueue"=>"/dev/mqueue", "hugetlbfs"=>"/dev/hugepages", "tracefs"=>"/sys/kernel/tracing", "configfs"=>"/sys/kernel/config", "fusectl"=>"/sys/fs/fuse/connections", "gvfsd-fuse"=>"/run/user/1000/gvfs", "/dev/sdb1"=>"/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f", "binfmt_misc"=>"/proc/sys/fs/binfmt_misc"}
+			#
+			# The return type is Hash.
+			# But if the status isn't available or the device isn't mounted, it will return an empty String.
+			def list_devices_mount_point
+				m = {}
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						m.merge!(_x[0] => _x[1])
+					end
+				end
+				m
+			end
+
+			##
+			# devices_stat
+			#
+			# [ Not to confuse this method with device_stat(dev) which shows only one device's info ]
+			#
+			# It shows all the block devices corresponding to mount points and data from LinuxStat::FS.stat(arg)
+			#
+			# For example:
+			#
+			#    LinuxStat::Mounts.devices_stat
+			#
+			#    => {"proc"=>{:mountpoint=>"/proc", :total=>0, :free=>0, :available=>0, :used=>0, :percent_used=>NaN, :percent_free=>NaN, :percent_available=>NaN}, "/dev/sdb1"=>{:mountpoint=>"/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f", :total=>31466008576, :free=>2693931008, :available=>2693931008, :used=>28772077568, :percent_used=>91.44, :percent_free=>8.56, :percent_available=>8.56}}
+			#
+			# The return type is Hash.
+			# But if the status isn't available, it will return an empty Hash.
+			def devices_stat
+				# Code duplication is fine if it gives maximum performance
+				m = {}
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						total, free, available, used = fs_info(_x[1])
+
+						m.merge!(_x[0] => {
+							mountpoint: _x[1],
+
+							total: total,
+							free: free,
+							available: available,
+							used: used,
+
+							percent_used: used.*(100).fdiv(total).round(2),
+							percent_free: free.*(100).fdiv(total).round(2),
+							percent_available: available.*(100).fdiv(total).round(2),
+						})
+					end
+				end
+				m
+			end
+
+			##
+			# device_stat(dev = root)
+			#
+			# [ Not to confuse this method with devices_stat() which shows all devices ]
+			#
+			# It shows all the block devices corresponding to mount points and data from LinuxStat::FS.stat(arg)
+			#
+			# For example:
+			#
+			#    LinuxStat::Mounts.device_stat('/dev/sda2')
+			#
+			#    => {"/dev/sda2"=>{:mountpoint=>"/", :total=>119981191168, :free=>35298562048, :available=>35298562048, :used=>84682629120, :percent_used=>70.58, :percent_free=>29.42, :percent_available=>29.42}}
+			#
+			# The return type is Hash.
+			# But if the status isn't available, it will return an empty Hash.
+			def device_stat(dev = root)
+				# Code duplication is fine if it gives maximum performance
+				m = {}
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						next if _x[0] != dev
+
+						total, free, available, used = fs_info(_x[1])
+
+						m.merge!({
+							mountpoint: _x[1],
+
+							total: total,
+							free: free,
+							available: available,
+							used: used,
+
+							percent_used: used.*(100).fdiv(total).round(2),
+							percent_free: free.*(100).fdiv(total).round(2),
+							percent_available: available.*(100).fdiv(total).round(2),
+						})
+
+						break
+					end
+				end
+				m
+			end
+
 			private
 			def mount_readable?
 				@@mount_readable ||= File.readable?('/proc/mounts')
@@ -59,6 +221,19 @@ module LinuxStat
 				return [] unless mount_readable?
 				@@root ||= IO.foreach('/proc/mounts').find { |x| x.split[1] == '/'.freeze }.split
 			end
+
+			def fs_info(dev)
+				# => [total, free, available, used]
+				s = LinuxStat::FS.stat(dev)
+				s.default = 0
+
+				[
+					s[:block_size] * s[:blocks],
+					s[:block_size] * s[:block_free],
+					s[:block_size] * s[:block_avail_unpriv],
+					s[:blocks].-(s[:block_free]) * s[:block_size]
+				]
+			end
 		end
 	end
 end

data/lib/linux_stat/net.rb

@@ -1,13 +1,131 @@
 module LinuxStat
 	module Net
 		class << self
+			DEV = '/proc/net/dev'.freeze
+
+			##
 			# Returns the local IP address of the system as a String.
+			#
 			# If the information isn't available, it will a frozen empty string.
 			def ipv4_private
-				require 'socket'
+				require 'socket' unless defined?(Socket)
 				ip = Socket.ip_address_list.find(&:ipv4_private?)
 				ip ? ip.ip? ? ip.ip_unpack[0].freeze : ''.freeze : ''.freeze
 			end
+
+			##
+			# Returns the total bytes received and transmitted as Hash.
+			#
+			# For example:
+			#    {:received=>56602867, :transmitted=>6940922}
+			#
+			# But if the status isn't available it will return an empty Hash.
+			def total_bytes
+				return {} unless File.readable?(DEV)
+
+				data = IO.readlines(DEV).drop(2)
+				indices = find_index_of_bytes
+				data.reject! { |x| x.strip.start_with?('lo:') }
+				r, t = data.map { |x| x.split.values_at(*indices).map(&:to_i) }.transpose.map(&:sum)
+
+				{
+					received: r,
+					transmitted: t
+				}
+			end
+
+			##
+			# Returns the total bytes received as Integer.
+			#
+			# But if the status isn't available it will return nil.
+			def total_bytes_received
+				return nil unless File.readable?(DEV)
+
+				data = IO.readlines(DEV).drop(2)
+				index = find_index_of_bytes[0]
+				data.reject! { |x| x.strip.start_with?('lo:') }
+				data.map { |x| x.split[index].to_i }.sum
+			end
+
+			##
+			# Returns the total bytes transmitted as Integer.
+			#
+			# But if the status isn't available it will return nil.
+			def total_bytes_transmitted
+				return nil unless File.readable?(DEV)
+
+				data = IO.readlines(DEV).drop(2)
+				index = find_index_of_bytes[-1]
+				data.reject! { |x| x.strip.start_with?('lo:') }
+				data.map { |x| x.split[index].to_i }.sum
+			end
+
+			##
+			# usage(interval = 0.1)
+			#
+			# Where interval is the time between polling in seconds. The default is 0.1 seconds.
+			#
+			# The return type is a Hash, containg the current internet usage (received, transmit) in B/s.
+			#
+			# For example:
+			#    {:received=>436060.0, :transmitted=>50350.0}
+			#
+			# If the system transmits 100 kb in the interval,
+			#
+			# this method will return 1000 kb/s. That is, it estimates
+			#
+			# the data it will transmit in one second. Thus, a good and reliable interval is 1 second
+			#
+			# It will return an empty Hash if the info (/proc/net/dev) isn't available.
+			def usage(interval = 0.1)
+				return {} unless File.readable?(DEV)
+
+				data = IO.readlines(DEV).drop(2)
+				indices = find_index_of_bytes
+				data.reject! { |x| x.strip.start_with?('lo:') }
+				r, t = data.map { |x| x.split.values_at(*indices).map(&:to_i) }.transpose.map(&:sum)
+
+				sleep(interval)
+
+				data2 = IO.readlines(DEV).drop(2)
+				data2.reject! { |x| x.strip.start_with?('lo:') }
+				r2, t2 = data2.map { |x| x.split.values_at(*indices).map(&:to_i) }.transpose.map(&:sum)
+
+				# Measure the difference
+				dr, dt = r2.-(r).fdiv(interval), t2.-(t).fdiv(interval)
+
+				{
+					received: dr,
+					transmitted: dt
+				}
+			end
+
+			alias current_usage usage
+
+			private
+			# Returns the index containing the received and transmitted bytes
+			def find_index_of_bytes
+				@@index_of_bytes ||= nil
+
+				unless @@index_of_bytes
+					data = IO.foreach(DEV)
+
+					r, h = data.next.split, {}
+
+					r.each_with_index { |x, i|
+						downcased = x.downcase
+						h.merge!(:r => i) if downcased.start_with?('receive')
+						h.merge!(:t => i) if downcased.start_with?('transmit')
+					}
+
+					data_0 = data.next.gsub(?|.freeze, ' %'.freeze)
+					@@index_of_bytes = []
+					data_0.split.each_with_index { |x, i| @@index_of_bytes << i if x == '%bytes'.freeze }
+					h[:r] > h[:t] ? @@index_of_bytes.reverse : @@index_of_bytes
+				else
+					@@index_of_bytes
+				end
+			end
 		end
 	end
 end