sys-uname 0.8.6 → 0.9.0

data/CHANGES

@@ -1,3 +1,8 @@
+== 0.9.0 - 8-Dec-2011
+* Conversion to FFI.
+* Added some additional methods and information for Solaris.
+* Minor tweaks for 1.9 to silence warnings.
+
 == 0.8.6 - 2-Sep-2011
 * Fixed a failing test for Ruby 1.9.x.
 * The gemspec for Windows is now 'universal'.

data/README

@@ -1,6 +1,9 @@
 = Description
   A Ruby interface for getting operating system information. The name comes
-  from the Unix 'uname' command, but this library works on Windows as well.
+  from the Unix 'uname' command, but this library works on MS Windows as well.
+
+= Prerequisites
+  ffi 1.0 or later
 
 = Installation
   gem install sys-uname
@@ -15,8 +18,8 @@
   p Uname.uname
    
 = Solaris Notes
-  Folks building this library on SunOS get two extra methods: architecture()
-  and platform()
+  Users on SunOS get several extra methods: architecture, platform,
+  hw_serial, hw_provider, srpc_domain, isa_list, and dhcp_cache.
 
 = BSD flavors, including OS X
   Users on BSD platforms get the extra Uname.model method.
@@ -28,7 +31,7 @@
 
 = MS Windows Notes
   The C version for Windows has been completely scrapped in favor of an OLE
-  plus WMI approach. It is pure Ruby. Please see the MSDN documentation for
+  plus WMI approach.  It is pure Ruby.  Please see the MSDN documentation for
   the Win32_OperatingSystem class for a complete list of what each of the
   UnameStruct members mean.
 

data/Rakefile

@@ -1,73 +1,50 @@
 require 'rake'
-require 'rake/clean'
 require 'rake/testtask'
+require 'rake/clean'
 require 'rbconfig'
-include Config
 
-WINDOWS = CONFIG['host_os'] =~ /msdos|mswin|win32|windows|mingw|cygwin/i
-
-CLEAN.include(
-  '**/*.gem',               # Gem files
-  '**/*.rbc',               # Rubinius
-  '**/*.o',                 # C object file
-  '**/*.log',               # Ruby extension build log
-  '**/Makefile',            # C Makefile
-  '**/conftest.dSYM',       # OS X build directory
-  "**/*.#{CONFIG['DLEXT']}" # C shared object
-)
-
-desc "Build the source for C extensions"
-task :build => [:clean] do
-  Dir.chdir("ext"){
-    ruby "extconf.rb"
-    sh "make"
-    cp "uname." + Config::CONFIG['DLEXT'], 'sys'
-  }
-end
+CLEAN.include("**/*.rbc", "**/*.rbx", "**/*.gem")
 
 desc "Run the example program"
-task :example => [:build] do
-  if WINDOWS
-    sh 'ruby -Ilib examples/uname_test.rb'
+task :example do
+  if File::ALT_SEPARATOR
+    sh 'ruby -Ilib/windows examples/uname_test.rb'
   else
-    sh 'ruby -Iext examples/uname_test.rb'
+    sh 'ruby -Ilib/unix examples/uname_test.rb'
   end
 end
 
-namespace 'gem' do
+namespace :gem do
   desc "Create the sys-uname gem"
-  task :create do
+  task :create => [:clean] do
     spec = eval(IO.read('sys-uname.gemspec'))
-    if WINDOWS
-      spec.files = spec.files.reject{ |f| f.include?('ext') }
+
+    if File::ALT_SEPARATOR
       spec.platform = Gem::Platform::CURRENT
       spec.platform.cpu = 'universal'
       spec.platform.version = nil
-      spec.original_platform = spec.platform
-    else
-      spec.files = spec.files.reject{ |f| f.include?('lib') }
-      spec.extensions = ['ext/extconf.rb']
-      spec.extra_rdoc_files += ['ext/sys/uname.c']
     end
+    
     Gem::Builder.new(spec).build
   end
 
   desc "Install the sys-uname gem"
-  task :install => [:create] do
-    file = Dir['sys-uname*.gem'].first
+  task :install => [:build] do
+    file = Dir["*.gem"].first
     sh "gem install #{file}"
   end
 end
 
 desc "Run the test suite"
 Rake::TestTask.new("test") do |t|
-  if WINDOWS
-    t.libs << 'lib'
+  if File::ALT_SEPARATOR
+    t.libs << 'lib/windows'
   else
-    task :test => :build
-    t.libs << 'ext'
-    t.libs.delete('lib')
+    t.libs << 'lib/unix'
   end
+
+  t.warning = true
+  t.verbose = true
 end
 
 task :default => :test

data/doc/uname.txt

@@ -26,25 +26,25 @@ VERSION
 
 == Class Methods
 Uname.sysname
-   Returns the operating system name, e.g. "SunOS"
+   Returns the operating system name.  e.g. "SunOS"
     
 Uname.nodename
-   Returns the nodename. This is usually, but not necessarily, the 
+   Returns the nodename.  This is usually, but not necessarily, the 
    same as the system's hostname.
 	
    You cannot currently set the nodename (root or otherwise). This may
    be added in a future release.
 
 Uname.machine
-   Returns the machine hardware type, e.g. "i686"
+   Returns the machine hardware type.  e.g. "i686"
     
 Uname.version
-   Returns the operating system version. e.g. "5.8". In the case of MS
+   Returns the operating system version. e.g. "5.8".  In the case of MS
    Windows, it returns the version plus patch information, separated by
    a hyphen, e.g. "2915-Service Pack 2".
     
 Uname.release
-   Returns the operating system release, e.g. "2.2.16-3"
+   Returns the operating system release. e.g. "2.2.16-3"
     
 Uname.uname
    Returns a struct of type UnameStruct that contains sysname, nodename,
@@ -57,10 +57,10 @@ Uname.uname
     
 == Solaris Only
 Uname.architecture
-   Returns the instruction set architecture, e.g. "sparc"
+   Returns the instruction set architecture.  e.g. "sparc"
     
 Uname.platform
-   Returns the platform identifier, e.g. "SUNW,Sun-Blade-100"
+   Returns the platform identifier.  e.g. "SUNW,Sun-Blade-100"
     
 Uname.isa_list
    Returns a space separated string containing a list of all variant
@@ -88,8 +88,8 @@ Uname.model
    Returns the model type,  e.g. "PowerBook5,1"
     
 == HP-UX Only
-Uname.id_number
-   Returns the id number, e.g. 234233587. This is a String, not a Fixnum.
+Uname.id
+   Returns the id number, e.g. 234233587.  This is a String, not a Fixnum.
 
 == Notes
    Not all of the information that you might be used to seeing with
@@ -109,10 +109,10 @@ Uname.id_number
    Add additional info for Linux, Solaris, BSD.
 
 == License
-   Artistic 2.0
+   Ruby's
 
 == Copyright
-   (C) 2002-2011 Daniel J. Berger
+   (C) 2002-2012 Daniel J. Berger
    All Rights Reserved
 
 == Warranty

data/examples/uname_test.rb

@@ -5,6 +5,7 @@
 # should generally be run via the 'rake example' task.
 ########################################################################
 require 'sys/uname'
+require 'rbconfig'
 include Sys
 
 puts "VERSION: " + Uname::VERSION
@@ -14,8 +15,8 @@ puts 'Version: ' + Uname.version
 puts 'Release: ' + Uname.release
 puts 'Machine: ' + Uname.machine # May be "unknown" on Win32
 
-if RUBY_PLATFORM =~ /sun|solaris/i
-   print "\nSolaris specific tests\n" 
+if RbConfig::CONFIG['host_os'] =~ /sun|solaris/i
+   print "\nSolaris specific tests\n"
    puts "==========================="
    puts 'Architecture: ' + Uname.architecture
    puts 'Platform: ' + Uname.platform
@@ -26,13 +27,13 @@ if RUBY_PLATFORM =~ /sun|solaris/i
    puts 'DHCP Cache: ' + Uname.dhcp_cache # might be empty
 end
 
-if RUBY_PLATFORM =~ /powerpc|darwin|bsd|mach/i
-   print "\nBSD/OS X specific tests\n" 
+if RbConfig::CONFIG['host_os'] =~ /powerpc|darwin|bsd|mach/i
+   print "\nBSD/OS X specific tests\n"
    puts "======================="
    puts 'Model: ' + Uname.model
 end
 
-if RUBY_PLATFORM =~ /hpux/i
+if RbConfig::CONFIG['host_os'] =~ /hpux/i
    print "\nHP-UX specific tests\n"
    puts "========================"
    puts "ID: " + Uname.id

data/lib/unix/sys/uname.rb

@@ -0,0 +1,327 @@
+require 'ffi'
+require 'rbconfig'
+require 'ostruct'
+
+# The Sys module serves as a namespace only.
+module Sys
+  # The Uname class encapsulates information about the system.
+  class Uname
+    extend FFI::Library
+    ffi_lib('c')
+
+    # Error raised if the uname() function fails.
+    class Error < StandardError; end
+
+    # The version of the sys-uname library
+    VERSION = '0.9.0'
+
+    # :stopdoc
+
+    # Buffer size for uname struct char arrays
+    case RbConfig::CONFIG['host_os']
+      when /linux/i
+        BUFSIZE = 65
+      when /bsd/i
+        BUFSIZE = 32 # TODO: version method chopped
+      when /sunos|solaris/i
+        BUFSIZE = 257
+      else
+        BUFSIZE = 256
+    end
+
+    attach_function :uname, [:pointer], :int
+
+    begin
+      attach_function :sysctl, [:pointer, :uint, :pointer, :pointer, :pointer, :size_t], :int
+      CTL_HW   = 6   # Generic hardware/cpu
+      HW_MODEL = 2   # Specific machine model
+    rescue FFI::NotFoundError
+      # Ignore. Not suppored.
+    end
+
+    begin
+      attach_function :sysinfo, [:int, :pointer, :long], :long
+      SI_SYSNAME      = 1   # OS name
+      SI_HOSTNAME     = 2   # Node name
+      SI_RELEASE      = 3   # Operating system release
+      SI_VERSION      = 4   # Version field of utsname
+      SI_MACHINE      = 5   # Machine type
+      SI_ARCHITECTURE = 6   # Instruction set architecture
+      SI_HW_SERIAL    = 7   # Hardware serial number
+      SI_HW_PROVIDER  = 8   # Hardware manufacturer
+      SI_SRPC_DOMAIN  = 9   # Secure RPC domain
+      SI_PLATFORM     = 513 # Platform identifier
+      SI_ISALIST      = 514 # Supported isalist
+      SI_DHCP_CACHE   = 515 # Kernel cached DHCPACK
+    rescue FFI::NotFoundError
+      # Ignore. Not suppored.
+    end
+
+    # Temporarily remove the uname method to avoid function name conflict
+    class << self
+      alias :uname_c :uname
+      remove_method :uname
+    end
+
+    class UnameFFIStruct < FFI::Struct
+      members = [
+        :sysname,  [:char, BUFSIZE],
+        :nodename, [:char, BUFSIZE],
+        :release,  [:char, BUFSIZE],
+        :version,  [:char, BUFSIZE],
+        :machine,  [:char, BUFSIZE]
+      ]
+
+      if RbConfig::CONFIG['host_os'] =~ /linux/i
+        members.push(:domainname, [:char, BUFSIZE])
+      end
+
+      if RbConfig::CONFIG['host_os'] =~ /hpux/i
+        members.push(:__id_number, [:char, BUFSIZE])
+      end
+
+      layout(*members)
+    end
+
+    fields = %w[
+      sysname
+      nodename
+      release
+      version
+      machine
+    ]
+
+    if RbConfig::CONFIG['host_os'] =~ /linux/i
+      fields.push('domainname')
+    end
+
+    if RbConfig::CONFIG['host_os'] =~ /hpux/i
+      fields.push('id_number')
+    end
+
+    if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
+      fields.push(
+        'architecture',
+        'dhcp_cache',
+        'hw_provider',
+        'hw_serial',
+        'isa_list',
+        'platform',
+        'srpc_domain'
+      )
+    end
+
+    if RbConfig::CONFIG['host_os'] =~ /darwin|bsd/i
+      fields.push('model')
+    end
+
+    # :startdoc:
+
+    UnameStruct = Struct.new("UnameStruct", *fields)
+
+    # Returns a struct that contains the sysname, nodename, machine, version
+    # and release of your system.
+    #
+    # On OS X it will also include the model.
+    #
+    # On Solaris, it will also include the architecture and platform.
+    #
+    # On HP-UX, it will also include the id_number.
+    #
+    # Example:
+    #
+    #   require 'sys/uname'
+    #
+    #   p Sys::Uname.uname
+    #
+    def self.uname
+      utsname = UnameFFIStruct.new
+
+      if uname_c(utsname) < 0
+        raise Error, "uname() function call failed"
+      end
+
+      struct = UnameStruct.new
+      struct[:sysname]  = utsname[:sysname].to_s
+      struct[:nodename] = utsname[:nodename].to_s
+      struct[:release]  = utsname[:release].to_s
+      struct[:version]  = utsname[:version].to_s
+      struct[:machine]  = utsname[:machine].to_s
+
+      if RbConfig::CONFIG['host_os'] =~ /darwin|bsd/i
+        struct[:model] = get_model()
+      end
+
+      if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
+        struct[:architecture] = get_si(SI_ARCHITECTURE)
+        struct[:platform]     = get_si(SI_PLATFORM)
+        struct[:hw_serial]    = get_si(SI_HW_SERIAL)
+        struct[:hw_provider]  = get_si(SI_HW_PROVIDER)
+        struct[:srpc_domain]  = get_si(SI_SRPC_DOMAIN)
+        struct[:isa_list]     = get_si(SI_ISALIST)
+        struct[:dhcp_cache]   = get_si(SI_DHCP_CACHE)
+
+        # FFI and Solaris don't get along so well, so we try again
+        struct[:sysname]  = get_si(SI_SYSNAME) if struct.sysname.empty?
+        struct[:nodename] = get_si(SI_HOSTNAME) if struct.nodename.empty?
+        struct[:release]  = get_si(SI_RELEASE) if struct.release.empty?
+        struct[:version]  = get_si(SI_VERSION) if struct.version.empty?
+        struct[:machine]  = get_si(SI_MACHINE) if struct.machine.empty?
+      end
+
+      if RbConfig::CONFIG['host_os'] =~ /hpux/i
+        struct[:id_number] = utsname[:__id_number].to_s
+      end
+
+      if RbConfig::CONFIG['host_os'] =~ /linux/i
+        struct[:domainname] = utsname[:domainname].to_s
+      end
+
+      # Let's add a members method that works for testing and compatibility
+      if struct.members.nil?
+        struct.instance_eval(%Q{
+          def members
+            @table.keys.map{ |k| k.to_s }
+          end
+        })
+      end
+
+      struct.freeze
+    end
+
+    # Returns the name of this implementation of the operating system.
+    #
+    # Example:
+    #
+    #  Uname.sysname # => 'SunOS'
+    #
+    def self.sysname
+      uname.sysname
+    end
+
+    # Returns the name of this node within the communications network to
+    # which this node is attached, if any. This is often, but not
+    # necessarily, the same as the host name.
+    #
+    # Example:
+    #
+    #  Uname.nodename # => 'your_host.foo.com'
+    #
+    def self.nodename
+      uname.nodename
+    end
+
+    # Returns the current release level of your operating system.
+    #
+    # Example:
+    #
+    #  Uname.release # => '2.2.16-3'
+    #
+    def self.release
+      uname.release
+    end
+
+    # Returns the current version level of your operating system.
+    #
+    # Example:
+    #
+    #  Uname.version # => '5.9'
+    #
+    def self.version
+      uname.version
+    end
+
+    # Returns the machine hardware type.
+    #
+    # Example:
+    #
+    #  Uname.machine # => 'i686'
+    #
+    def self.machine
+      uname.machine
+    end
+
+    if defined? :sysctl
+      # Returns the model type.
+      #
+      # Example:
+      #
+      #  Uname.model # => 'MacBookPro5,3'
+      #
+      def self.model
+        uname.model
+      end
+    end
+
+    if defined? :sysinfo
+      # The  basic instruction  set  architecture  of  the current
+      # system, e.g. sparc, i386, etc.
+      #
+      def self.architecture
+        uname.architecture
+      end
+
+      # The specific model of the hardware platform, e.g Sun-Blade-1500, etc.
+      #
+      def self.platform
+        uname.platform
+      end
+
+      # The string consisting of the ASCII hexidecimal encoding of the name
+      # of the interface configured by boot(1M) followed by the DHCPACK reply
+      # from the server.
+      #
+      def self.dhcp_cache
+        uname.dhcp_cache
+      end
+
+      # The variant instruction set architectures executable on the
+      # current system.
+      #
+      def self.isa_list
+        uname.isa_list
+      end
+
+      # The ASCII representation of the hardware-specific serial number
+      # of the physical machine on which the function is executed.
+      #
+      def self.hw_serial
+        uname.hw_serial.to_i
+      end
+
+      # The name of the of the hardware provider.
+      #
+      def self.hw_provider
+        uname.hw_provider
+      end
+
+      # The Secure Remote Procedure Call domain name.
+      #
+      def self.srpc_domain
+        uname.srpc_domain
+      end
+    end
+
+    private
+
+    # Returns the model for systems that define sysctl().
+    #
+    def self.get_model
+      buf  = 0.chr * BUFSIZE
+      mib  = FFI::MemoryPointer.new(:int, 2).write_array_of_int([CTL_HW, HW_MODEL])
+      size = FFI::MemoryPointer.new(:long, 1).write_int(buf.size)
+
+      sysctl(mib, 2, buf, size, nil, 0)
+
+      buf.strip
+    end
+
+    # Returns the various sysinfo information based on +flag+.
+    #
+    def self.get_si(flag)
+      buf = 0.chr * BUFSIZE
+      sysinfo(flag, buf, BUFSIZE)
+      buf.strip
+    end
+  end
+end