sys-cpu 0.5.5 → 0.6.0

data/CHANGES

@@ -1,3 +1,15 @@
+== 0.6.0 - 26-Apr-2007
+* Added support for most BSD flavors, including OS X. The freebsd.c file is
+  now just bsd.c.
+* The CPU.type method for Solaris has been changed to CPU.cpu_type to avoid
+  conflicting with the Object.type method.
+* Added a Rakefile. There are now tasks for building, testing and installing,
+  among other things. Run 'rake -T' to check your options.
+* Many internal directory layout changes - C source files are now under the
+  'ext' directory.
+* Improved RDoc comments in the C source files.
+* Changed CPUError to CPU::Error.
+
 == 0.5.5 - 17-Nov-2006
 * Fixed a bug in the Linux version where there could be a key but no
    associated value, causing a String#strip! call to fail.  Now the value is

data/MANIFEST

@@ -0,0 +1,28 @@
+* install.rb
+* MANIFEST
+* CHANGES
+* Rakefile
+* README
+* sys-cpu.gemspec
+* doc/bsd.txt
+* doc/hpux.txt
+* doc/linux.txt
+* doc/sunos.txt
+* doc/windows.txt
+* examples/test_cpu_freebsd.rb
+* examples/test_cpu_hpux.rb
+* examples/test_cpu_linux.rb
+* examples/test_cpu_sunos.rb
+* examples/test_cpu_windows.rb
+* ext/extconf.rb
+* ext/version.h
+* ext/bsd/bsd.c
+* ext/hpux/hpux.c
+* ext/sunos/sunos.c
+* lib/sys/linux.rb
+* lib/sys/windows.rb
+* test/tc_bsd.rb
+* test/tc_hpux.rb
+* test/tc_sunos.rb
+* test/tc_linux.rb
+* test/tc_windows.rb

data/README

@@ -2,26 +2,27 @@
    A Ruby interface for getting cpu information.
 
 = Installation
-=== Linux and Windows:
-   ruby test/ts_all.rb (optional)
-   ruby install.rb
-
-=== All other platforms:
-   ruby extconf.rb
-   make
-   ruby test/ts_all.rb (optional)
-   make site-install
+== Standard Installation
+   rake test (optional)
+   rake install (non-gem)
+== Gem installation
+   rake test (optional)
+   ruby sys-cpu.gemspec
+   gem install sys-cpu-X.Y.Z.gem # where 'X.Y.Z' corresponds to the version.
 
 = Notes
 === All Platforms
    As of version 0.5.0 Ruby 1.8.0 or later is required.  It may work with
-   earlier versions, but I will not support it.  In addition, a test file is
-   no longer auto-generated for you.  If wish to run the test suite, cd to the
-   'test' directory and run the test suite appropriate for your platform.
+   earlier versions, but I will not support it.
 
 === Solaris
    Currently there is no 'processors()' iterative method for multi-cpu systems.
    I plan to add it this in a future release.
+   
+=== OS X
+   The CPU.freq method is not supported at the moment. The sysctl() approach
+   returns a bogus, hard coded value of some sort. I suspect it's possible
+   by using kernel modules via kldload(), but I'm not sure how yet.
 
 === Linux
    This is pure Ruby.  This version reads information out of /proc/cpuinfo and
@@ -35,14 +36,14 @@
    The text documentation for Linux is dynamically generated during the
    build process because the fields vary depending on your setup.  So, don't
    look at it until *after* you've installed it.  You will see a doc/linux.txt
-   file after you run install.rb.
+   file after you run 'rake install' (via install.rb).
 
 === HP-UX
    Unlike other platforms, you can get load averages for an individual cpu (in
-   multi-cpu systems).  See documentation for more details.
+   multi-cpu systems). See documentation for more details.
 
-=== Win32
-   This is a pure Ruby implementation using the win32ole package + WMI.  The C
+=== MS Windows
+   This is a pure Ruby implementation using the win32ole package + WMI. The C
    version has been scrapped. 
 
    As of version 0.5.0, the CPU.usage method has been removed in favor of the
@@ -56,15 +57,15 @@
    http://www.rubyforge.org/projects/sysutils.
 
 = Future Plans
-=== Solaris
    Add iterative CPU.processors method.
+   Make CPU.freq work on OS X.
    Add more information in general, such as what 'prtdiag' shows.
 
 = License
    Ruby's.
 
 = Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
 
 = Warranty
@@ -74,5 +75,5 @@
 
 = Author
    Daniel J. Berger
-   djberg96 at gmail dot com
+   djberg96 at nospam at gmail dot com
    imperator on IRC (irc.freenode.net)

data/doc/{freebsd.txt → bsd.txt}

@@ -5,7 +5,7 @@
    require "sys/cpu"
    include Sys
 
-   # FreeBSD
+   # BSD and OS X
    puts "Architecture: " + CPU.architecture
    puts "Machine: " + CPU.machine
    puts "Mhz: " + CPU.cpu_freq.to_s
@@ -24,6 +24,8 @@ CPU.architecture
 CPU.freq
    Returns an integer indicating the speed (i.e. frequency in Mhz) of
    the cpu.
+   
+   Not supported on OS X.
     
 CPU.load_avg
    Returns an array of three floats indicating the 1, 5 and 15 minute load
@@ -39,16 +41,16 @@ CPU.num_cpu
    Returns an integer indicating the number of cpu's on the system.
     
 = Error Classes
-CPUError < StandardError
+CPU::Error < StandardError
    Raised is response to internal function errors, usually relating to an
    invalid cpu number.
     
 = Known Bugs
    None known.  Please post bug reports to the SourceForge home page at
-   http://www.rubyforge.org/projects/sysutils
+   http://www.rubyforge.org/projects/sysutils 
     
 = Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
     
 = Warranty
@@ -61,5 +63,5 @@ CPUError < StandardError
     
 = Author
    Daniel J. Berger
-   djberg96 at yahoo dot com
-   imperator/rubyhacker1 on IRC (Freenode)
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)

data/doc/hpux.txt

@@ -46,7 +46,7 @@ CPU.num_active_cpu
    Returns an integer indicating the number of active cpu's on the system.
     
 = Error Classes
-CPUError < StandardError
+CPU::Error < StandardError
    Raised is response to internal function errors, usually relating to an
    invalid cpu number.
     
@@ -58,7 +58,7 @@ CPUError < StandardError
    Add cpu model and type
    
 = Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
     
 = Warranty
@@ -71,5 +71,5 @@ CPUError < StandardError
     
 = Author
    Daniel J. Berger
-   djberg96 at yahoo dot com
-   imperator/rubyhacker1 on IRC (Freenode)
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)

data/doc/sunos.txt

@@ -48,7 +48,7 @@ CPU.state(cpu_num)
    Returns a string indicating the cpu state of 'cpu_num'.
     
 = Error Classes
-CPUError < StandardError
+CPU::Error < StandardError
    Raised is response to internal function errors, usually relating to an
    invalid cpu number.
     
@@ -61,7 +61,7 @@ CPUError < StandardError
    Get the model() method to display more specific information.
     
 = Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
     
 = Warranty
@@ -74,3 +74,5 @@ CPUError < StandardError
     
 = Author
    Daniel J. Berger
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)

data/doc/windows.txt

@@ -102,7 +102,7 @@ CPU.type(host=localhost)
     Returns a string indicating the type of processor, e.g. GenuineIntel.
     
 = Exception Classes
-CPUError < StandardError
+CPU::Error < StandardError
    Raised is response to internal function errors, most likely to be raised
    in the event that in invalid cpu number is provided for the 'freq'
    method.
@@ -135,7 +135,7 @@ CPUError < StandardError
    Win32_PerfFormattedData_PerfOS_Processor class.
     
 = Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
     
 = Warranty
@@ -148,5 +148,5 @@ CPUError < StandardError
     
 = Author
    Daniel J. Berger
-   djberg96 at yahoo dot com
+   djberg96 at nospam at gmail dot com
    imperator/rubyhacker1 on IRC (Freenode)

data/ext/bsd/bsd.c

@@ -0,0 +1,252 @@
+/*****************************************************************************
+ * bsd.c (cpu.c) - sys-cpu extension for the various BSD flavors and OS X.
+ *
+ * Author: Daniel J. Berger
+ *
+ * Interface to provide various types of cpu information.
+ * Based on the Unix::Processors Perl module (Wilson Snyder) with ideas from
+ * Sys::CPU (Matt Sanford) and Solaris::Kstat (Alan Burlison) as well.
+ * 
+ * Portions of this code lifted from the MPlayer source (cpuinfo.c).
+ *****************************************************************************/
+#include <ruby.h>
+#include "version.h"
+#include <kvm.h>
+#include <sys/sysctl.h>
+#include <sys/types.h>
+#include <string.h>
+#include <errno.h>
+
+#ifndef MISSING_USLEEP
+#include <unistd.h>
+#endif
+
+VALUE cCPUError;
+
+/****************************************************************************
+ * Used for FreeBSD 4.x to determine CPU clock speed.  Stolen from cpuinfo.c
+ * in the MPlayer source code.
+ ****************************************************************************/
+#if defined (__FreeBSD__) && (__FreeBSD__ < 5 )
+static int64_t rdtsc(void){
+   unsigned int i, j;
+#define RDTSC  ".byte 0x0f, 0x31; "
+   asm(RDTSC : "=a"(i), "=d"(j) : );
+   return ((int64_t)j<<32) + (int64_t)i;
+}
+#endif
+
+/*
+ * call-seq:
+ *    CPU.load_average   
+ * 
+ * Returns an array of three floats indicating the 1, 5 and 15 minute load
+ * average.
+ */
+static VALUE cpu_load_avg(VALUE klass){
+   kvm_t* k;
+   double avgs[3];
+   int n, max = 3;
+   VALUE v_num_array = rb_ary_new();
+   
+   k = malloc(sizeof(kvm_t*));
+   
+   if(!kvm_getloadavg(k, avgs, max))
+      rb_raise(cCPUError, "error calling kvm_getloadavg(): %s", strerror(errno));
+   
+   for(n = 0; n < 3; n++)
+      rb_ary_push(v_num_array, rb_float_new(avgs[n]));
+
+   free(k);
+
+   return v_num_array;
+}
+
+/*
+ * call-seq:
+ *    CPU.num_cpu
+ *
+ * Returns the number of cpu's on your system. Note that each core on
+ * multi-core systems are counted as a cpu, e.g. one dual core cpu would
+ * return 2, not 1.
+ */
+static VALUE cpu_num(VALUE klass){
+   int num_cpu;
+   size_t len = sizeof(num_cpu);
+
+#ifdef HAVE_SYSCTLBYNAME
+   if(sysctlbyname("hw.ncpu", &num_cpu, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctlbyname(): %s", strerror(errno));
+#else
+   int mib[2];
+   mib[0] = CTL_HW;
+   mib[1] = HW_NCPU;
+   
+   if(sysctl(mib, 2, &num_cpu, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctl(): %s", strerror(errno));
+#endif
+
+   return INT2NUM(num_cpu);  
+}
+
+/*
+ * call-seq:
+ *    CPU.model
+ *
+ * Returns a string indicating the cpu model.
+ */
+static VALUE cpu_model(VALUE klass){
+   char model[64];
+   size_t len = sizeof(model);
+
+#ifdef HAVE_SYSCTLBYNAME
+   if(sysctlbyname("hw.model", &model, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctlbyname(): %s", strerror(errno));
+#else
+   int mib[2];
+   mib[0] = CTL_HW;
+   mib[1] = HW_MODEL;
+   
+   if(sysctl(mib, 2, &model, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctl(): %s", strerror(errno));
+#endif
+
+   return rb_str_new2(model);
+}
+
+/*
+ * call-seq:
+ *    CPU.architecture
+ *
+ * Returns the cpu's architecture. On most systems this will be identical
+ * to the CPU.machine method.
+ */
+static VALUE cpu_architecture(VALUE klass){
+   char arch[32];
+   size_t len = sizeof(arch);
+
+#ifdef HAVE_SYSCTLBYNAME
+#if defined(__MACH__) && defined(__APPLE__)
+   if(sysctlbyname("hw.machine", &arch, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctlbyname(): %s", strerror(errno));
+#else
+   if(sysctlbyname("hw.machine_arch", &arch, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctlbyname(): %s", strerror(errno));
+#endif
+#else
+   int mib[2];
+   mib[0] = CTL_HW;
+   mib[1] = HW_MACHINE_ARCH;
+
+   if(sysctl(mib, 2, &arch, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctl(): %s", strerror(errno));
+#endif
+
+   return rb_str_new2(arch);
+}
+
+/*
+ * call-seq:
+ *    CPU.machine
+ *
+ * Returns the cpu's class type. On most systems this will be identical
+ * to the CPU.architecture method.
+ */
+static VALUE cpu_machine(VALUE klass){
+   char machine[32];
+   size_t len = sizeof(machine);
+
+#ifdef HAVE_SYSCTLBYNAME
+   if(sysctlbyname("hw.machine", &machine, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctlbyname(): %s", strerror(errno));
+#else
+   int mib[2];
+   mib[0] = CTL_HW;
+   mib[1] = HW_MACHINE;
+
+   if(sysctl(mib, 2, &machine, &len, NULL, 0))
+      rb_raise(cCPUError, "error calling sysctl(): %s", strerror(errno));
+#endif
+
+   return rb_str_new2(machine);
+}
+
+/*
+ * call-seq:
+ *    CPU.freq
+ *
+ * Returns an integer indicating the speed (i.e. frequency in Mhz) of the cpu.
+ * 
+ * Not supported on OS X.
+ *--
+ * Not supported on OS X currently. The sysctl() approach returns a bogus
+ * hard-coded value.
+ * 
+ * TODO: Fix for OS X.
+ */
+static VALUE cpu_freq(VALUE klass){
+   int mhz;
+#if defined (__FreeBSD__) && (__FreeBSD__ < 5)
+   int64_t tsc_start, tsc_end;
+   struct timeval tv_start, tv_end;
+   int usec_delay;
+   
+   tsc_start = rdtsc();
+   gettimeofday(&tv_start,NULL);
+#ifdef MISSING_USLEEP
+   sleep(1);
+#else
+   usleep(100000);
+#endif
+   tsc_end = rdtsc();
+   gettimeofday(&tv_end,NULL);
+   
+   usec_delay = 1000000 * (tv_end.tv_sec - tv_start.tv_sec)
+      + (tv_end.tv_usec - tv_start.tv_usec);
+      
+   mhz = ((tsc_end - tsc_start) / usec_delay);
+#else
+   size_t len = sizeof(mhz);
+#ifdef HAVE_SYSCTLBYNAME
+   if(sysctlbyname("hw.clockrate", &mhz, &len, 0, 0))
+      rb_raise(cCPUError, "error calling sysctlbyname(): %s", strerror(errno));
+#else
+   int mib[2];
+
+   mib[0] = CTL_KERN;
+   mib[1] = KERN_CLOCKRATE;
+
+   if(sysctl(mib, 2, &mhz, &len, NULL, 0)
+      rb_raise(cCPUError,"error calling sysctlbyname(): %s", strerror(errno));
+#endif
+#endif
+
+   return INT2NUM(mhz);
+}
+
+void Init_cpu()
+{
+   VALUE mSys, cCPU;
+
+   /* The Sys module serves as a toplevel namespace only */
+   mSys = rb_define_module("Sys");
+
+   /* The CPU class provides class methods for obtaining CPU information */
+   cCPU = rb_define_class_under(mSys, "CPU", rb_cObject);
+
+   /* The CPU::Error Exception class is raised whenever any of the CPU class
+    * methods fail.
+    */
+   cCPUError = rb_define_class_under(cCPU, "Error", rb_eStandardError);
+
+   /* 0.6.0: The version of this package, returned as a String */
+   rb_define_const(cCPU, "VERSION", rb_str_new2(SYS_CPU_VERSION));
+
+   /* Class Methods */
+   rb_define_singleton_method(cCPU, "architecture", cpu_architecture, 0);
+   rb_define_singleton_method(cCPU, "freq", cpu_freq, 0);
+   rb_define_singleton_method(cCPU, "load_avg", cpu_load_avg, 0);
+   rb_define_singleton_method(cCPU, "machine", cpu_machine, 0);
+   rb_define_singleton_method(cCPU, "model", cpu_model, 0);
+   rb_define_singleton_method(cCPU, "num_cpu", cpu_num, 0);
+}

data/ext/extconf.rb

@@ -0,0 +1,24 @@
+require "mkmf"
+require "fileutils"
+
+File.delete('cpu.c') if File.exists?('cpu.c')
+
+case RUBY_PLATFORM
+   when /hpux/i
+      FileUtils.cp("hpux/hpux.c", "cpu.c")
+   when /sunos|solaris/i
+      FileUtils.cp("sunos/sunos.c", "cpu.c")
+      unless have_func("getloadavg")
+         have_library("kstat")
+      end
+   when /bsd|darwin/i
+      FileUtils.cp("bsd/bsd.c", "cpu.c")
+      have_func("sysctlbyname")
+      have_library("kvm")
+   when /linux|dos|windows|win32|mingw|cygwin/i
+      STDERR.puts "Run 'ruby install.rb' instead for this platform"
+   else
+      STDERR.puts "This platform is not currently supported.  Exiting..."
+end
+
+create_makefile("sys/cpu")