sys-uname 0.8.5-x86-mingw32 → 0.9.0-x86-mingw32

data/doc/uname.txt

@@ -1,127 +1,127 @@
-== 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.
-
-== Synopsis
-   require 'sys/uname'
-   include Sys
-
-   # Unix
-   puts Uname.nodename  => my_host
-   puts Uname.version   => #1 Fri Oct 24 22:43:28 MDT 2003
-   puts Uname.sysname   => Linux
-   puts Uname.machine   => i686
-   puts Uname.release   => 2.4.22-21mdk
-	
-   p Uname.uname        => Show all UnameStruct members
-
-   # Windows
-   u = Uname.uname
-   puts u.caption     => 'Microsoft Windows XP Home Edition
-   puts u.csd_version => 'Service Pack 2'
-
-== Constants
-VERSION
-   The current version number of the sys-uname library. This is a String.
-
-== Class Methods
-Uname.sysname
-   Returns the operating system name.  e.g. "SunOS"
-    
-Uname.nodename
-   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"
-    
-Uname.version
-   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"
-    
-Uname.uname
-   Returns a struct of type UnameStruct that contains sysname, nodename,
-   machine, version, and release.  On Solaris, it will also include 
-   architecture and platform.  On HP-UX, it will also include id_number.
-    
-   MS Windows - there are many more, and different, fields in the struct.
-   Please see the MSDN documenation on the Win32_OperatingSystem WMI class
-   for a complete explanation of what each of these members mean.
-    
-== Solaris Only
-Uname.architecture
-   Returns the instruction set architecture.  e.g. "sparc"
-    
-Uname.platform
-   Returns the platform identifier.  e.g. "SUNW,Sun-Blade-100"
-    
-Uname.isa_list
-   Returns a space separated string containing a list of all variant
-   instruction set architectures executable on the current system.
-	 
-   They are listed in order of performance, from best to worst.
-
-Uname.hw_provider
-   Returns the name of the hardware manufacturer.
-
-Uname.hw_serial_number
-   Returns the ASCII representation of the hardware-specific serial number
-   of the machine that executes the function.
-
-Uname.srpc_domain
-   Returns the name of the Secure Remote Procedure Call domain, if any.
-
-Uname.dhcp_cache
-   Returns a hexidecimal encoding, in String form, of the name of the
-   interface configured by boot(1M) followed by the DHCPACK reply from
-   the server.
-    
-== BSD Platforms Only (including OS X)
-Uname.model
-   Returns the model type,  e.g. "PowerBook5,1"
-    
-== HP-UX Only
-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
-   a 'uname -a' is available.  This may be added in future releases,
-   but since different implementations provide different information
-   (via different header files) it will be a bit of a pain.
-
-   Windows users - please see the MSDN documentation for the
-   Win32_OperatingSystem class for a complete list of what each of the
-   UnameStruct members mean.
-
-== Known Bugs
-   None that I'm aware of.  Please log any bugs on the project page at
-   http://www.rubyforge.org/projects/sysutils.
-	
-== Future Plans
-   Add additional info for Linux, Solaris, BSD.
-
-== License
-   Artistic 2.0
-
-== Copyright
-   (C) 2002-2010 Daniel J. Berger
-   All Rights Reserved
-
-== Warranty
-   This package is provided "as is" and without any express or
-   implied warranties, including, without limitation, the implied
-   warranties of merchantability and fitness for a particular purpose.
-
-== Author
-   Daniel Berger
-	
-== See Also
-   uname(1) for unix, or WMI for MS Windows.
+== 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.
+
+== Synopsis
+   require 'sys/uname'
+   include Sys
+
+   # Unix
+   puts Uname.nodename  => my_host
+   puts Uname.version   => #1 Fri Oct 24 22:43:28 MDT 2003
+   puts Uname.sysname   => Linux
+   puts Uname.machine   => i686
+   puts Uname.release   => 2.4.22-21mdk
+	
+   p Uname.uname        => Show all UnameStruct members
+
+   # Windows
+   u = Uname.uname
+   puts u.caption     => 'Microsoft Windows XP Home Edition
+   puts u.csd_version => 'Service Pack 2'
+
+== Constants
+VERSION
+   The current version number of the sys-uname library. This is a String.
+
+== Class Methods
+Uname.sysname
+   Returns the operating system name.  e.g. "SunOS"
+    
+Uname.nodename
+   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"
+    
+Uname.version
+   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"
+    
+Uname.uname
+   Returns a struct of type UnameStruct that contains sysname, nodename,
+   machine, version, and release.  On Solaris, it will also include 
+   architecture and platform.  On HP-UX, it will also include id_number.
+    
+   MS Windows - there are many more, and different, fields in the struct.
+   Please see the MSDN documenation on the Win32_OperatingSystem WMI class
+   for a complete explanation of what each of these members mean.
+    
+== Solaris Only
+Uname.architecture
+   Returns the instruction set architecture.  e.g. "sparc"
+    
+Uname.platform
+   Returns the platform identifier.  e.g. "SUNW,Sun-Blade-100"
+    
+Uname.isa_list
+   Returns a space separated string containing a list of all variant
+   instruction set architectures executable on the current system.
+	 
+   They are listed in order of performance, from best to worst.
+
+Uname.hw_provider
+   Returns the name of the hardware manufacturer.
+
+Uname.hw_serial_number
+   Returns the ASCII representation of the hardware-specific serial number
+   of the machine that executes the function.
+
+Uname.srpc_domain
+   Returns the name of the Secure Remote Procedure Call domain, if any.
+
+Uname.dhcp_cache
+   Returns a hexidecimal encoding, in String form, of the name of the
+   interface configured by boot(1M) followed by the DHCPACK reply from
+   the server.
+    
+== BSD Platforms Only (including OS X)
+Uname.model
+   Returns the model type,  e.g. "PowerBook5,1"
+    
+== HP-UX Only
+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
+   a 'uname -a' is available.  This may be added in future releases,
+   but since different implementations provide different information
+   (via different header files) it will be a bit of a pain.
+
+   Windows users - please see the MSDN documentation for the
+   Win32_OperatingSystem class for a complete list of what each of the
+   UnameStruct members mean.
+
+== Known Bugs
+   None that I'm aware of.  Please log any bugs on the project page at
+   http://www.rubyforge.org/projects/sysutils.
+	
+== Future Plans
+   Add additional info for Linux, Solaris, BSD.
+
+== License
+   Ruby's
+
+== Copyright
+   (C) 2002-2012 Daniel J. Berger
+   All Rights Reserved
+
+== Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+
+== Author
+   Daniel Berger
+	
+== See Also
+   uname(1) for unix, or WMI for MS Windows.

data/examples/uname_test.rb

@@ -1,41 +1,42 @@
-########################################################################
-# uname_test.rb
-#
-# Generic test script for general futzing. Modify as you see fit. This
-# should generally be run via the 'rake example' task.
-########################################################################
-require 'sys/uname'
-include Sys
-
-puts "VERSION: " + Uname::VERSION
-puts 'Nodename: ' + Uname.nodename
-puts 'Sysname: ' + Uname.sysname
-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" 
-   puts "==========================="
-   puts 'Architecture: ' + Uname.architecture
-   puts 'Platform: ' + Uname.platform
-   puts 'Instruction Set List: ' + Uname.isa_list.split.join(", ")
-   puts 'Hardware Provider: ' + Uname.hw_provider
-   puts 'Serial Number: ' + Uname.hw_serial_number.to_s
-   puts 'SRPC Domain: ' + Uname.srpc_domain # might be empty
-   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" 
-   puts "======================="
-   puts 'Model: ' + Uname.model
-end
-
-if RUBY_PLATFORM =~ /hpux/i
-   print "\nHP-UX specific tests\n"
-   puts "========================"
-   puts "ID: " + Uname.id
-end
-
-print "\nTest finished successfully\n"
+########################################################################
+# uname_test.rb
+#
+# Generic test script for general futzing. Modify as you see fit. This
+# should generally be run via the 'rake example' task.
+########################################################################
+require 'sys/uname'
+require 'rbconfig'
+include Sys
+
+puts "VERSION: " + Uname::VERSION
+puts 'Nodename: ' + Uname.nodename
+puts 'Sysname: ' + Uname.sysname
+puts 'Version: ' + Uname.version
+puts 'Release: ' + Uname.release
+puts 'Machine: ' + Uname.machine # May be "unknown" on Win32
+
+if RbConfig::CONFIG['host_os'] =~ /sun|solaris/i
+   print "\nSolaris specific tests\n"
+   puts "==========================="
+   puts 'Architecture: ' + Uname.architecture
+   puts 'Platform: ' + Uname.platform
+   puts 'Instruction Set List: ' + Uname.isa_list.split.join(", ")
+   puts 'Hardware Provider: ' + Uname.hw_provider
+   puts 'Serial Number: ' + Uname.hw_serial_number.to_s
+   puts 'SRPC Domain: ' + Uname.srpc_domain # might be empty
+   puts 'DHCP Cache: ' + Uname.dhcp_cache # might be empty
+end
+
+if RbConfig::CONFIG['host_os'] =~ /powerpc|darwin|bsd|mach/i
+   print "\nBSD/OS X specific tests\n"
+   puts "======================="
+   puts 'Model: ' + Uname.model
+end
+
+if RbConfig::CONFIG['host_os'] =~ /hpux/i
+   print "\nHP-UX specific tests\n"
+   puts "========================"
+   puts "ID: " + Uname.id
+end
+
+print "\nTest finished successfully\n"

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