linux_stat 1.0.3 → 1.2.2

data/ext/sysconf/sysconf.c

@@ -119,6 +119,15 @@ static VALUE getEUID(VALUE obj) {
 	return INT2FIX(geteuid()) ;
 }
 
+static VALUE getHostname(VALUE obj) {
+	int h_max = sysconf(_SC_HOST_NAME_MAX) + 1 ;
+	char hostname[h_max] ;
+
+	short int status = gethostname(hostname, h_max) ;
+
+	return (status < 0) ? rb_str_new_cstr("") : rb_str_new_cstr(hostname) ;
+}
+
 void Init_sysconf() {
 	VALUE _linux_stat = rb_define_module("LinuxStat") ;
 	VALUE _sysconf = rb_define_module_under(_linux_stat, "Sysconf") ;
@@ -144,4 +153,6 @@ void Init_sysconf() {
 
 	rb_define_module_function(_sysconf, "get_user", getUser, 0) ;
 	rb_define_module_function(_sysconf, "get_login", getUser, 0) ;
+
+	rb_define_module_function(_sysconf, "hostname", getHostname, 0) ;
 }

data/lib/linux_stat.rb

@@ -15,8 +15,8 @@
 
 # Miscellaneous Modules
 # Independed and LinuxStat's miscellaneous modules
-require "linux_stat/version"
 require 'linux_stat/prettify_bytes'
+require "linux_stat/version"
 
 # Independed Modules
 # Modules that doesn't have any dependency on its own
@@ -25,6 +25,7 @@ require "linux_stat/battery"
 require "linux_stat/bios"
 require "linux_stat/memory"
 require "linux_stat/net"
+require "linux_stat/pci"
 require "linux_stat/process"
 require "linux_stat/swap"
 require "linux_stat/usb"

data/lib/linux_stat/os.rb

@@ -51,14 +51,46 @@ module LinuxStat
 						v[:DISTRIB_DESCRIPTION]
 					elsif v.key?(:DISTRIB_ID)
 						v[:DISTRIB_ID]
-					elsif File.readable?('/etc/issue')
-						IO.read('/etc/issue').strip
+					elsif File.readable?('/etc/issue'.freeze)
+						IO.read('/etc/issue'.freeze, encoding: 'ASCII-8bit').strip
 					else
 						'Unknown'.freeze
 					end
 				end
 			end
 
+			##
+			# Gives you the version of the OS you are using.
+			#
+			# On ArchLinux for example:
+			#    LinuxStat::OS.version
+			#
+			#    => "rolling"
+			#
+			# On Ubuntu 20.04:
+			#    LinuxStat::OS.version
+			#
+			#    => "20.04"
+			#
+			# On CentOS 26:
+			#    LinuxStat::OS.version
+			#
+			#    => "26"
+			#
+			# The return type is String.
+			# But if the information isn't available, it will return an empty frozen String.
+			def version
+				@@distrib_version ||= if os_release.key?(:VERSION_ID)
+					os_release[:VERSION_ID]
+				elsif lsb_release.key?(:DISTRIB_RELEASE)
+					lsb_release[:DISTRIB_RELEASE]
+				elsif os_release.key?(:VERSION)
+					os_release[:VERSION]
+				else
+					''.freeze
+				end
+			end
+
 			##
 			# Uses utsname.h to determine the machine
 			#
@@ -70,22 +102,18 @@ module LinuxStat
 			##
 			# Uses utsname.h to determine the system nodename
 			#
-			# It returns String but if the info isn't available, it will return an empty String
+			# It returns String but if the info isn't available, it will return an empty String.
 			def nodename
-				@@nodename ||= LinuxStat::Uname.nodename
+				LinuxStat::Uname.nodename
 			end
 
 			##
-			# Reads /etc/hostname and returns the hostname.
+			# Returns the hostname from LinuxStat::Sysconf.hostname.
 			#
 			# The return type is String.
-			# If the info info isn't available, it will return 'localhost'.
+			# If the info info isn't available, it will return an empty String.
 			def hostname
-				@@hostname ||= if File.exist?('/etc/hostname')
-					IO.read('/etc/hostname').strip
-				else
-					'localhost'
-				end
+				LinuxStat::Sysconf.hostname
 			end
 
 			##
@@ -114,7 +142,7 @@ module LinuxStat
 			def uptime
 				return {} unless uptime_readable?
 
-				uptime = IO.read('/proc/uptime').to_f
+				uptime = IO.read('/proc/uptime'.freeze).to_f
 				uptime_i = uptime.to_i
 
 				h = uptime_i / 3600
@@ -128,16 +156,21 @@ module LinuxStat
 				}.freeze
 			end
 
+			alias distrib_version version
+
 			private
 			def release(file)
 				IO.readlines(file, 4096).reduce({}) { |h, x|
 					x.strip!
 					next h if x.empty?
 
-					splitted = x.split(?=)
+					splitted = x.split(?=.freeze)
+
+					key = splitted[0].to_s
+					key.strip!
 
-					key = splitted[0].to_s.strip
-					value = splitted[1..-1].join(?=).to_s.strip
+					value = splitted[1..-1].join(?=.freeze).to_s
+					value.strip!
 
 					value[0] = ''.freeze if value[0] == ?".freeze
 					value[-1] = ''.freeze if value[-1] == ?".freeze

data/lib/linux_stat/pci.rb

@@ -0,0 +1,366 @@
+module LinuxStat
+	module PCI
+		class << self
+			##
+			# = devices_info(hwdata: true)
+			#
+			# [ Not to be confused with devices_stat ]
+			#
+			# Take a look at LinuxStat::PCI.devices_stat for more info.
+			#
+			# Returns details about the devices found in /proc/bus/pci/devices file.
+			#
+			# The details doesn't contain a lot of details, it opens just one file.
+			#
+			# The return value is an Array of multiple Hashes. If there's no info available,
+			# it will rather return an empty Array.
+			#
+			# On Android Termux for example, it can not list the directories because they are
+			# not readable the the regular user.
+			#
+			# It can have information like:
+			#
+			# id, vendor, device, irq, and kernel_driver
+			#
+			# An example of the returned sample from a test machine is:
+			#    LinuxStat::PCI.devices_info
+			#
+			#    => [{:id=>"8086:1904", :vendor=>"8086", :device=>"1904", :irq=>0, :kernel_driver=>"skl_uncore", :hwdata=>{:vendor=>"Intel Corporation", :product=>"Xeon E3-1200 v5/E3-1500 v5/6th Gen Core Processor Host Bridge/DRAM Registers"}}]
+			#
+			# Right, it's an Array of Hashes.
+			#
+			# It also takes one option. The hwdata, which is true by default.
+			#
+			# Information about usb devices is found inside /usr/share/hwdata/pci.ids
+			#
+			# The data contains the vendor and the product, the subvendor and the subproduct.
+			#
+			# If the option is enabled, it will try read /usr/share/hwdata/pci.ids
+			#
+			# But the file will be read only once. The consecutive calls to this method
+			# won't open the hwdata all the times.
+			#
+			# But if there's no hwdata, the Hash returned by this method will not contain
+			# hwdata key.
+			#
+			# The data is only populated if it's available. For example, if there's no
+			# manufacturer available for the product, the returned Hash will not contain the
+			# information about the manufacturer.
+			#
+			# Also note that if there's no info available or no PCI enabled devices, it will return an empty
+			# Hash.
+			def devices_info(hwdata: true)
+				@@proc_pci_readable ||= File.readable?('/proc/bus/pci/devices')
+				return {} unless @@proc_pci_readable
+
+				IO.readlines('/proc/bus/pci/devices'.freeze).map! { |dev|
+					x = dev.split
+
+					vendor = x[1][0..3]
+					device = x[1][4..-1]
+					irq = x[2].to_i(16)
+					kernel_driver = x[-1]
+
+					query = if hwdata
+						query_hwdata(vendor, device)
+					else
+						{}
+					end
+
+					ret = {
+						id: "#{vendor}:#{device}",
+						vendor: vendor, device: device,
+						irq: irq,
+						kernel_driver: kernel_driver
+					}
+
+					ret.merge!(hwdata: query) unless query.empty?
+
+					ret
+				}
+			end
+
+			##
+			# = devices_stat(hwdata: true)
+			#
+			# Returns details about the devices found in /sys/bus/pci/devices/
+			#
+			# The return value is an Array of multiple Hashes. If there's no info available,
+			# it will rather return an empty Array.
+			#
+			# On Android Termux for example, it can not list the directories because they are
+			# not readable the the regular user.
+			#
+			# It can have information like:
+			#
+			# path, id, vendor, device, subvendor, sub_device,
+			# kernel_driver, revision, irq, enable, hwdata.
+			#
+			# An example of the returned sample from a test machine is:
+			#    LinuxStat::PCI.devices_stat
+			#
+			#    => [{:path=>"/sys/bus/pci/devices/0000:00:00.0/", :id=>"8086:1904", :vendor=>"8086", :device=>"1904", :sub_vendor=>"1028", :sub_device=>"077d", :kernel_driver=>"skl_uncore", :revision=>"0x08", :irq=>0, :enable=>false, :hwdata=>{:vendor=>"Intel Corporation", :product=>"Xeon E3-1200 v5/E3-1500 v5/6th Gen Core Processor Host Bridge/DRAM Registers", :sub_system=>nil}}]
+			#
+			# Right, it's an Array of Hashes.
+			#
+			# It also takes one option. The hwdata, which is true by default.
+			#
+			# Information about usb devices is found inside /usr/share/hwdata/pci.ids
+			#
+			# The data contains the vendor and the product, the subvendor and the subproduct.
+			#
+			# If the option is enabled, it will try read /usr/share/hwdata/pci.ids
+			#
+			# But the file will be read only once. The consecutive calls to this method
+			# won't open the hwdata all the times.
+			#
+			# But if there's no hwdata, the Hash returned by this method will not contain
+			# hwdata key.
+			#
+			# The data is only populated if it's available. For example, if there's no
+			# manufacturer available for the product, the returned Hash will not contain the
+			# information about the manufacturer.
+			#
+			# If there's no /sys/bus/pci/devices/, it will call LinuxStat::PCI.devices_info
+			#
+			# Also note that if there's no info available or no PCI enabled devices, it will return an empty
+			# Hash.
+			def devices_stat(hwdata: true)
+				@@sys_pci_readable ||= File.readable?('/sys/bus/pci/devices/')
+				return devices_info(hwdata: hwdata) unless @@sys_pci_readable
+
+				Dir['/sys/bus/pci/devices/*/'.freeze].sort!.map! { |x|
+					begin
+						_vendor_file = File.join(x, 'vendor'.freeze)
+						next unless File.readable?(_vendor_file)
+						vendor = IO.read(_vendor_file).to_i(16).to_s(16)
+						prepend_0(vendor)
+
+						_device_file = File.join(x, 'device'.freeze)
+						next unless File.readable?(_device_file)
+						device = IO.read(_device_file).to_i(16).to_s(16)
+						prepend_0(device)
+
+						_sub_vendor_file = File.join(x, 'subsystem_vendor'.freeze)
+						sub_vendor = File.readable?(_sub_vendor_file) ? IO.read(_sub_vendor_file).to_i(16).to_s(16) : nil
+						prepend_0(sub_vendor) if sub_vendor
+
+						_sub_device_file = File.join(x, 'subsystem_device'.freeze)
+						sub_device = File.readable?(_sub_device_file) ? IO.read(_sub_device_file).to_i(16).to_s(16) : nil
+						prepend_0(sub_device) if sub_device
+
+						_uevent = File.join(x, 'uevent'.freeze)
+						uevent = File.readable?(_uevent) ? IO.foreach(_uevent) : nil
+
+						kernel_driver = if uevent
+							uevent.find { |_x|
+								_x.split(?=.freeze)[0].to_s.tap(&:strip!) == 'DRIVER'.freeze
+							} &.split(?=) &.[](1) &.tap(&:strip!)
+						else
+							nil
+						end
+
+						_revision_file = File.join(x, 'revision'.freeze)
+						revision = File.readable?(_revision_file) ? IO.read(_revision_file).tap(&:strip!) : ''.freeze
+
+						_irq_file = File.join(x, 'irq'.freeze)
+						irq = File.readable?(_irq_file) ? IO.read(_irq_file).to_i : nil
+
+						_enable_file = File.join(x, 'enable'.freeze)
+						enable = File.readable?(_enable_file) ? IO.read(_enable_file).to_i  == 1 : nil
+
+						query = if hwdata && sub_vendor && sub_device
+							query_hwdata(vendor, device, sub_vendor, sub_device)
+						elsif hwdata && sub_vendor
+							query_hwdata(vendor, device, sub_vendor)
+						elsif hwdata
+							query_hwdata(vendor, device)
+						else
+							{}
+						end
+
+						ret = {
+							path: x, id: "#{vendor}:#{device}",
+							vendor: vendor, device: device
+						}
+
+						ret.merge!(sub_vendor: sub_vendor) if sub_vendor
+						ret.merge!(sub_device: sub_device) if sub_device
+
+						ret.merge!(kernel_driver: kernel_driver) if kernel_driver
+						ret.merge!(revision: revision) unless revision.empty?
+						ret.merge!(irq: irq) if irq
+						ret.merge!(enable: enable) unless enable.nil?
+						ret.merge!(hwdata: query) unless query.empty?
+
+						ret
+					rescue StandardError
+					end
+				}.tap(&:compact!)
+			end
+
+			##
+			# Reads /proc/bus/pci/devices, counts and returns the total number of lines.
+			#
+			# But if the information isn't available, it will look into the contents of
+			# /sys/bus/pci/devices, and counts the total number of
+			# devices connected to the PCI.
+			# It checks for devices with vendor and device id files.
+			# If there's no such file, it will not count them as a PCI connected device.
+			#
+			# The return type is an integer.
+			#
+			# But if the information isn't available, it will return nil.
+			def count
+				@@proc_pci_readable ||= File.readable?('/proc/bus/pci/devices')
+				@@sys_pci_readable ||= File.readable?('/sys/bus/pci/devices/')
+
+				if @@proc_pci_readable
+					IO.readlines('/proc/bus/pci/devices'.freeze).length
+
+				elsif @@sys_pci_readable
+					Dir['/sys/bus/pci/devices/*/'.freeze].count { |x|
+						id_vendor_file = File.join(x, 'vendor'.freeze)
+						id_product_file = File.join(x, 'device'.freeze)
+						File.readable?(id_vendor_file) && File.readable?(id_product_file)
+					}
+
+				else
+					nil
+				end
+			end
+
+			##
+			# hwdata_file = file
+			#
+			# Lets you set the hwdata_file about pci.ids.
+			#
+			# The hwdata file about pci.ids contains vendor name and product name information about
+			# devices. This is then mapped by the other methods that utilizes hwdata/pci.ids.
+			#
+			# Do note that this method is intended to run only once, at the beginning.
+			# If you use any other method that utilizes hwdata/pci.ids, before
+			# calling this method, this method will not work.
+			def hwdata_file=(file)
+				@@hwdata_file ||= file.freeze
+			end
+
+			##
+			# Checks if hwdata_file is already initialized or not.
+			# Once it's initialized, calling hwdata_file = 'something/pci.ids' is futile.
+			def hwdata_file_set?
+				@@hwdata_file ||= false
+				!!@@hwdata_file
+			end
+
+			##
+			# Returns the hwdata_file as string.
+			#
+			# If hwdata_file isn't set, it will return an empty frozen string.
+			#
+			# Once it's set, it can't be changed.
+			def hwdata_file
+				@@hwdata_file ||= nil
+				@@hwdata_file ? @@hwdata_file : ''.freeze
+			end
+
+			##
+			# Initializes hwdata
+			#
+			# hwdata can take upto 0.1 to 0.2 seconds to get initialized.
+			#
+			# Calling this method will load hwdata for future use.
+			#
+			# Once it's initialized, hwdata_file can't be changed.
+			#
+			# If this method initializes hwdata, it will return true
+			# Othewise this method will return false.
+			def initialize_hwdata
+				@@hwdata ||= nil
+				init = !@@hwdata
+				hwdata
+				init
+			end
+
+			alias count_devices count
+
+			private
+			def hwdata
+				@@hwdata_file ||= "/usr/share/hwdata/pci.ids".freeze
+
+				@@hwdata ||= if File.readable?(@@hwdata_file)
+					ret, vendor_id, device_id, device = {}, nil, nil, nil
+					i = -1
+
+					file_data = IO.readlines(@@hwdata_file, encoding: 'ASCII-8BIT')
+					file_data_size = file_data.size
+
+					while (i += 1) < file_data_size
+						x = file_data[i]
+
+						_lstripped = x.lstrip
+						next if _lstripped[0] == ?#.freeze || _lstripped.empty?
+
+						if x[0..1] == "\t\t".freeze
+							next unless device_id
+
+							x.strip!
+							sub_device_id = x[/\A.*?\s/].to_s.strip
+							sub_device = x[device_id.length..-1].to_s.strip
+
+							if ret[vendor_id] &.at(1) &.[](device_id) &.[](1)
+								sub_system_id = sub_device[/\A.*?\s/].to_s.strip
+								sub_system_device = sub_device[sub_system_id.length..-1].to_s.strip
+
+								ret[vendor_id][1][device_id][1].merge!(sub_device_id => {sub_system_id => sub_system_device})
+							end
+
+						elsif x[0] == ?\t.freeze
+							next unless vendor_id
+
+							x.strip!
+							device_id = x[/\A.*?\s/].to_s.strip
+							device = x[device_id.length..-1].to_s.strip
+							ret[vendor_id][1][device_id] = [device, {}]
+
+						else
+							x.strip!
+							vendor_id = x[/\A.*?\s/].to_s.strip
+							vendor = x[vendor_id.length..-1].to_s.strip
+							ret[vendor_id] = [vendor, {}]
+						end
+					end
+
+					ret.freeze
+				else
+					{}
+				end
+			end
+
+			def prepend_0(n)
+				n[0, 0] = ?0.*(4 - n.length).freeze if n.length < 4
+				n
+			end
+
+			def query_hwdata(vendor_id, product_id, sub_vendor_id = nil, sub_device_id = nil)
+				vendor = hwdata[vendor_id]
+
+				if vendor
+					ret = {
+						vendor: vendor[0],
+						product: vendor.dig(1, product_id, 0),
+					}
+
+					if sub_vendor_id && sub_device_id
+						sub_product = vendor.dig(1, product_id, 1, sub_vendor_id, sub_device_id)
+						ret.merge!(sub_system: sub_product) if sub_product
+					end
+
+					ret
+ 				else
+					{}
+				end
+			end
+		end
+	end
+end