Class: Sys::CPU
- Inherits:
-
Object
- Object
- Sys::CPU
- Extended by:
- FFI::Library
- Defined in:
- lib/linux/sys/cpu.rb,
lib/unix/sys/cpu.rb,
lib/windows/sys/cpu.rb
Overview
Encapsulates system CPU information
Defined Under Namespace
Classes: CPUStruct, Error, ProcInfo
Constant Summary collapse
- VERSION =
The version of the sys-cpu library
'0.7.0'
- CTL_HW =
Generic hardware/cpu
6
- HW_MACHINE =
Machine class
1
- HW_MODEL =
Specific machine model
2
- HW_NCPU =
Number of CPU’s
3
- HW_CPU_FREQ =
CPU frequency
15
- HW_MACHINE_ARCH =
Machine architecture
12
- SI_MACHINE =
5
- SI_ARCHITECTURE =
6
- SC_NPROCESSORS_ONLN =
15
- P_OFFLINE =
1
- P_ONLINE =
2
- P_FAULTED =
4
- P_POWEROFF =
5
- P_NOINTR =
6
- P_SPARE =
7
- CPU_ARCH_ABI64 =
0x01000000
- CPU_TYPE_X86 =
7
- CPU_TYPE_X86_64 =
(CPU_TYPE_X86 | CPU_ARCH_ABI64)
- CPU_TYPE_SPARC =
14
- CPU_TYPE_POWERPC =
18
- CPU_TYPE_POWERPC64 =
CPU_TYPE_POWERPC | CPU_ARCH_ABI64
Class Method Summary collapse
-
.architecture(host = Socket.gethostname) ⇒ Object
Returns the
host
CPU’s architecture, or nil if it cannot be determined. -
.cpu_stats ⇒ Object
Returns a hash of arrays that contain the number of seconds that the system spent in user mode, user mode with low priority (nice), system mode, and the idle task, respectively.
-
.cpu_type(host = Socket.gethostname) ⇒ Object
Returns a string indicating the type of processor, e.g.
- .fpu_type ⇒ Object
-
.freq(cpu_num = 0, host = Socket.gethostname) ⇒ Object
Returns an integer indicating the speed (i.e. frequency in Mhz) of
cpu_num
onhost
, or the localhost if nohost
is specified. -
.load_avg(cpu_num = 0, host = Socket.gethostname) ⇒ Object
Returns the load capacity for
cpu_num
onhost
, or the localhost if no host is specified, averaged to the last second. - .machine ⇒ Object
-
.model(host = Socket.gethostname) ⇒ Object
Returns a string indicating the cpu model, e.g.
-
.num_cpu(host = Socket.gethostname) ⇒ Object
Returns an integer indicating the number of cpu’s on the system.
-
.processors(host = Socket.gethostname) ⇒ Object
Returns a CPUStruct for each CPU on
host
, or the localhost if nohost
is specified. - .state(num = 0) ⇒ Object
Class Method Details
.architecture(host = Socket.gethostname) ⇒ Object
Returns the host
CPU’s architecture, or nil if it cannot be determined.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/windows/sys/cpu.rb', line 75 def self.architecture if respond_to?(:sysinfo, true) buf = 0.chr * 257 if sysinfo(SI_ARCHITECTURE, buf, buf.size) < 0 raise Error, "sysinfo function failed" end buf.strip elsif respond_to?(:sysctlbyname, true) optr = FFI::MemoryPointer.new(:char, 256) size = FFI::MemoryPointer.new(:size_t) size.write_int(optr.size) if RbConfig::CONFIG['host_os'] =~ /darwin/i name = 'hw.machine' else name = 'hw.machine_arch' end if sysctlbyname(name, optr, size, nil, 0) < 0 raise Error, "sysctlbyname function failed" end optr.read_string else buf = 0.chr * 64 mib = FFI::MemoryPointer.new(:int, 2) size = FFI::MemoryPointer.new(:long, 1) mib.write_array_of_int([CTL_HW, HW_MACHINE_ARCH]) size.write_int(buf.size) if sysctl(mib, 2, buf, size, nil, 0) < 0 raise Error, "sysctl function failed" end buf.strip end end |
.cpu_stats ⇒ Object
Returns a hash of arrays that contain the number of seconds that the system spent in user mode, user mode with low priority (nice), system mode, and the idle task, respectively.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/linux/sys/cpu.rb', line 99 def self.cpu_stats cpu_stat_file = "/proc/stat" hash = {} # Hash needed for multi-cpu systems lines = IO.readlines(cpu_stat_file) lines.each_with_index{ |line, i| array = line.split break unless array[0] =~ /cpu/ # 'cpu' entries always on top # Some machines list a 'cpu' and a 'cpu0'. In this case only # return values for the numbered cpu entry. if lines[i].split[0] == "cpu" && lines[i+1].split[0] =~ /cpu\d/ next end vals = array[1..-1].map{ |e| e = e.to_i / 100 } # 100 jiffies/sec. hash[array[0]] = vals } hash end |
.cpu_type(host = Socket.gethostname) ⇒ Object
Returns a string indicating the type of processor, e.g. GenuineIntel.
258 259 260 261 262 263 264 265 266 267 |
# File 'lib/windows/sys/cpu.rb', line 258 def self.cpu_type(host = Socket.gethostname) cs = BASE_CS + "//#{host}/root/cimv2:Win32_Processor='cpu0'" begin wmi = WIN32OLE.connect(cs) rescue WIN32OLERuntimeError => e raise Error, e else return wmi.Manufacturer end end |
.fpu_type ⇒ Object
306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/unix/sys/cpu.rb', line 306 def self.fpu_type raise NoMethodError unless respond_to?(:processor_info, true) pinfo = ProcInfo.new if processor_info(0, pinfo) < 0 if processor_info(1, pinfo) < 0 raise Error, "process_info function failed" end end pinfo[:pi_fputypes].to_s end |
.freq(cpu_num = 0, host = Socket.gethostname) ⇒ Object
Returns an integer indicating the speed (i.e. frequency in Mhz) of cpu_num
on host
, or the localhost if no host
is specified. If cpu_num
+1 is greater than the number of cpu’s on your system or this call fails for any other reason, a Error is raised.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/windows/sys/cpu.rb', line 91 def self.freq if respond_to?(:sysctlbyname, true) optr = FFI::MemoryPointer.new(:long) size = FFI::MemoryPointer.new(:size_t) size.write_long(optr.size) if RbConfig::CONFIG['host_os'] =~ /bsd/i name = 'hw.clockrate' else name = 'hw.cpufrequency' end if sysctlbyname(name, optr, size, nil, 0) < 0 raise Error, "sysctlbyname failed" end if RbConfig::CONFIG['host_os'] =~ /darwin/i optr.read_long / 1000000 else optr.read_long end elsif respond_to?(:sysctl, true) buf = 0.chr * 16 mib = FFI::MemoryPointer.new(:int, 2) size = FFI::MemoryPointer.new(:long, 1) mib.write_array_of_int([CTL_HW, HW_CPU_FREQ]) size.write_int(buf.size) if sysctl(mib, 2, buf, size, nil, 0) < 0 raise Error, "sysctl function failed" end buf.unpack("I*").first / 1000000 else pinfo = ProcInfo.new # Some systems start at 0, some at 1 if processor_info(0, pinfo) < 0 if processor_info(1, pinfo) < 0 raise Error, "process_info function failed" end end pinfo[:pi_clock].to_i end end |
.load_avg(cpu_num = 0, host = Socket.gethostname) ⇒ Object
Returns the load capacity for cpu_num
on host
, or the localhost if no host is specified, averaged to the last second. Processor loading refers to the total computing burden for each processor at one time.
Note that this attribute is actually the LoadPercentage. I may use one of the Win32_Perf* classes in the future.
90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/linux/sys/cpu.rb', line 90 def self.load_avg if respond_to?(:getloadavg, true) loadavg = FFI::MemoryPointer.new(:double, 3) if getloadavg(loadavg, loadavg.size) < 0 raise Error, "getloadavg function failed" end loadavg.get_array_of_double(0, 3) end end |
.machine ⇒ Object
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/unix/sys/cpu.rb', line 170 def self.machine if respond_to?(:sysctl, true) buf = 0.chr * 32 mib = FFI::MemoryPointer.new(:int, 2) size = FFI::MemoryPointer.new(:long, 1) mib.write_array_of_int([CTL_HW, HW_MACHINE]) size.write_int(buf.size) if sysctl(mib, 2, buf, size, nil, 0) < 0 raise Error, "sysctl function failed" end buf.strip else buf = 0.chr * 257 if sysinfo(SI_MACHINE, buf, buf.size) < 0 raise Error, "sysinfo function failed" end buf.strip end end |
.model(host = Socket.gethostname) ⇒ Object
Returns a string indicating the cpu model, e.g. Intel Pentium 4.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/windows/sys/cpu.rb', line 123 def self.model if RbConfig::CONFIG['host_os'] =~ /darwin/i ptr = FFI::MemoryPointer.new(:long) size = FFI::MemoryPointer.new(:size_t) size.write_long(ptr.size) if sysctlbyname("hw.cputype", ptr, size, nil, 0) < 0 raise "sysctlbyname function failed" end case ptr.read_long when CPU_TYPE_X86, CPU_TYPE_X86_64 "Intel" when CPU_TYPE_SPARC "Sparc" when CPU_TYPE_POWERPC, CPU_TYPE_POWERPC64 "PowerPC" else "Unknown" end else if respond_to?(:sysctl, true) buf = 0.chr * 64 mib = FFI::MemoryPointer.new(:int, 2) size = FFI::MemoryPointer.new(:long, 1) mib.write_array_of_int([CTL_HW, HW_MODEL]) size.write_int(buf.size) if sysctl(mib, 2, buf, size, nil, 0) < 0 raise Error, "sysctl function failed" end buf.strip else pinfo = ProcInfo.new # Some systems start at 0, some at 1 if processor_info(0, pinfo) < 0 if processor_info(1, pinfo) < 0 raise Error, "process_info function failed" end end pinfo[:pi_processor_type].to_s end end end |
.num_cpu(host = Socket.gethostname) ⇒ Object
Returns an integer indicating the number of cpu’s on the system. – This (oddly) requires a different class.
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/windows/sys/cpu.rb', line 138 def self.num_cpu if respond_to?(:sysctlbyname, true) optr = FFI::MemoryPointer.new(:long) size = FFI::MemoryPointer.new(:size_t) size.write_long(optr.size) if sysctlbyname('hw.ncpu', optr, size, nil, 0) < 0 raise Error, "sysctlbyname failed" end optr.read_long elsif respond_to?(:sysconf, true) num = sysconf(SC_NPROCESSORS_ONLN) if num < 0 raise Error, "sysconf function failed" end num else buf = 0.chr * 4 mib = FFI::MemoryPointer.new(:int, 2) size = FFI::MemoryPointer.new(:long, 1) mib.write_array_of_int([CTL_HW, HW_NCPU]) size.write_int(buf.size) if sysctl(mib, 2, buf, size, nil, 0) < 0 raise Error, "sysctl function failed" end buf.strip.unpack("C").first end end |
.processors(host = Socket.gethostname) ⇒ Object
Returns a CPUStruct for each CPU on host
, or the localhost if no host
is specified. A CPUStruct contains the following members:
-
address_width
-
architecture
-
availability
-
caption
-
config_manager_error_code
-
config_manager_user_config
-
cpu_status
-
creation_class_name
-
freq
-
voltage
-
data_width
-
description
-
device_id
-
error_cleared?
-
error_description
-
ext_clock
-
family
-
install_date
-
l2_cache_size
-
l2_cache_speed
-
last_error_code
-
level
-
load_avg
-
manufacturer
-
max_clock_speed
-
name
-
other_family_description
-
pnp_device_id
-
power_management_supported?
-
power_management_capabilities
-
processor_id
-
processor_type
-
revision
-
role
-
socket_designation
-
status
-
status_info
-
stepping
-
system_creation_class_name
-
system_name
-
unique_id
-
upgrade_method
-
version
-
voltage_caps
Note that not all of these members will necessarily be defined.
58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/linux/sys/cpu.rb', line 58 def self.processors array = [] $cpu_array.each{ |hash| struct = CPUStruct.new struct.members.each{ |m| struct.send("#{m}=", hash[m]) } if block_given? yield struct else array << struct end } array unless block_given? end |
.state(num = 0) ⇒ Object
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/unix/sys/cpu.rb', line 320 def self.state(num = 0) raise NoMethodError unless respond_to?(:processor_info, true) pinfo = ProcInfo.new if processor_info(num, pinfo) < 0 raise Error, "process_info function failed" end case pinfo[:pi_state].to_i when P_ONLINE "online" when P_OFFLINE "offline" when P_POWEROFF "poweroff" when P_FAULTED "faulted" when P_NOINTR "nointr" when P_SPARE "spare" else "unknown" end end |