solaris-kstat 1.0.1 → 1.0.2

data/CHANGES

@@ -1,3 +1,16 @@
+== 1.0.2 - 29-Jul-2011
+* Fixed a bug where the name hash keys could potentially be overwritten if there
+  were multiple statistics for the same name. Thanks go to Jens Deppe for the
+  spot and the patch.
+* Added the "class" information to the statistics hash.
+* Rakefile refactored. The old style of library installation has been removed.
+  Use the 'gem' tasks now. In addition, gem creation is now handled via a Rake
+  task now.
+* Some minor modifications to the gemspec to reflect the changes in the
+  Rakefile, as well as a change required due to the switch from CVS to git.
+* Added a .gitignore file.
+* Changed license to Artistic 2.0.
+
 == 1.0.1 - 27-Aug-2009
 * Changed the license to Artistic 2.0.
 * Fixed warnings that could occur if the @module, @name, or @instance

data/README

@@ -1,18 +1,11 @@
 == Description
-   Ruby extension for the Solaris kstat library.
+   A Ruby interface for the Solaris kstat library.
    
 == Prerequisites
-   Solaris 8 (2.8) or later.
-   Ruby 1.8.x
+   Solaris 8 (SunOS 2.8) or later.
 
 == Installation
-=== Manual Installation
-   rake test (optional)
-   rake install
-
-=== Gem Installation
-   rake test (optional)
-   rake install_gem
+   gem install solaris-kstat
 
 == Synopsis
    require 'solaris/kstat'
@@ -20,7 +13,7 @@
    include Solaris
 
    k = Kstat.new('cpu_info', 0, 'cpu_info0')
-   pp k
+   pp k.record
 
    {'cpu_info'=>
       {0=>
@@ -64,7 +57,7 @@ Kstat::Error < StandardError
    * sfmmu_percpu_stat
    
 == Known Bugs
-   You will receive a couple warnings during the build process. You
+   You may receive a couple warnings during the build process. You
    can ignore these.
 
 == Designer's Notes
@@ -81,13 +74,13 @@ Kstat::Error < StandardError
    Thanks go to Charlie Mills for help with the 'volatile' issue.
 
 == Future Plans
-   Eliminate warnings that occur during the build process, if possible.
+   Add snaptime and crtime information to the statistics hash.
    
 == License
-   Ruby's
+   Artistic 2.0
 
 == Copyright
-   (C) 2003-2008 Daniel J. Berger
+   (C) 2003-2011 Daniel J. Berger
    All Rights Reserved
     
 == Warranty
@@ -97,8 +90,6 @@ Kstat::Error < StandardError
 	 
 == Author
    Daniel J. Berger
-   djberg96 at nospam at gmail dot com
-   imperator on IRC (freenode)
     
 == See Also
    kstat(1M)

data/Rakefile

@@ -4,56 +4,50 @@ require 'rake/testtask'
 require 'rbconfig'
 include Config
 
-desc "Clean the build files for the solaris-kstat source"
-task :clean do
-   FileUtils.rm_rf('solaris') if File.exists?('solaris')
-
-   Dir.chdir('ext') do
-      FileUtils.rm_rf('rkstat.c') if File.exists?('rkstat.c')
-      FileUtils.rm_rf('rkstat.h') if File.exists?('rkstat.h')
-      sh 'make distclean' if File.exists?('kstat.so')
-      FileUtils.rm_rf('solaris/kstat.so') if File.exists?('solaris/kstat.so')
-   end
-end
-
-desc "Build the solaris-kstat package (but don't install it)"
-task :build => [:clean] do
-   Dir.chdir('ext') do
-      ruby 'extconf.rb'
-      sh 'make'
-      Dir.mkdir('solaris') unless File.exists?('solaris')
-      FileUtils.cp('kstat.so', 'solaris')
-   end
-end
-
-desc "Install the solaris-kstat package (non-gem)"
-task :install => [:build] do
-   Dir.chdir('ext') do
-      sh 'make install'
-   end
-end
-
-desc "Install the solaris-kstat package as a gem"
-task :install_gem do
-   ruby 'solaris-kstat.gemspec'
-   file = Dir["*.gem"].first
-   sh "gem install #{file}"
+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 solaris-kstat source"
+task :build do
+  Dir.chdir('ext') do
+    ruby 'extconf.rb'
+    sh 'make'
+    cp 'kstat.so', 'solaris'
+  end
 end
 
-desc "Uninstall the solaris-kstat package. Use 'gem uninstall' for gem installs"
-task :uninstall => [:clean] do
-   file = File.join(CONFIG['sitearchdir'], 'solaris', 'kstat.so')
-   FileUtils.rm_rf(file) if File.exists?(file)
+namespace :gem do
+  desc "Create the solaris-kstat gem"
+  task :create => [:clean] do
+    spec = eval(IO.read('solaris-kstat.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc "Install the solaris-kstat gem"
+  task :install => [:build] do
+    ruby 'solaris-kstat.gemspec'
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
 end
 
 desc "Run the example program"
 task :example => [:build] do
-   ruby "-Iext examples/example_kstat.rb"
+  ruby "-Iext examples/example_kstat.rb"
 end
 
 Rake::TestTask.new do |t|
-   task :test => :build
-   t.libs << 'ext'
-   t.verbose = true
-   t.warning = true
+  task :test => [:build]
+  t.libs << 'ext'
+  t.verbose = true
+  t.warning = true
 end
+
+task :default => :test

data/ext/solaris/rkstat.c

@@ -20,8 +20,8 @@ extern "C" {
 VALUE cKstatError;
 
 static VALUE ks_allocate(VALUE klass){
-   KstatStruct* ptr;
-   return Data_Make_Struct(klass, KstatStruct, 0, ks_free, ptr);
+  KstatStruct* ptr;
+  return Data_Make_Struct(klass, KstatStruct, 0, ks_free, ptr);
 }
 
 /*
@@ -37,36 +37,53 @@ static VALUE ks_allocate(VALUE klass){
  * name defaults to nil (all names).
  */
 VALUE ks_init(int argc, VALUE* argv, VALUE self){
-   KstatStruct* ptr;
-   VALUE v_module, v_instance, v_name;
-
-   Data_Get_Struct(self,KstatStruct,ptr);
-
-   rb_scan_args(argc, argv, "03", &v_module, &v_instance, &v_name);
-
+  KstatStruct* ptr;
+  VALUE v_module, v_instance, v_name;
+
+  Data_Get_Struct(self,KstatStruct,ptr);
+
+  rb_scan_args(argc, argv, "03", &v_module, &v_instance, &v_name);
+
+  if(!NIL_P(v_module)){
+    SafeStringValue(v_module);
+    rb_iv_set(self, "@module", v_module);
+  }
+  else{
+    rb_iv_set(self, "@module", Qnil);
+  }
+
+  if(!NIL_P(v_name)){
+    SafeStringValue(v_name);
+    rb_iv_set(self, "@name", v_name);
+  }
+  else{
+    rb_iv_set(self, "@name", Qnil);
+  }
+
+  if(!NIL_P(v_instance))
+    rb_iv_set(self, "@instance", v_instance);
+  else
+    rb_iv_set(self, "@instance", Qnil);
+
+  return self;
+}
 
-   if(!NIL_P(v_module)){
-      SafeStringValue(v_module);
-      rb_iv_set(self, "@module", v_module);
-   }
-   else{
-      rb_iv_set(self, "@module", Qnil);
-   }
+/*
+ * Helper function ks_record which will either return an existing value for
+ * the given key, or assign that key a new empty hash if it has no value
+ * associated with it.
+ */
+VALUE get_hash_for_key(VALUE v_hash, VALUE v_key){
+  volatile VALUE v_new_hash;
 
-   if(!NIL_P(v_name)){
-      SafeStringValue(v_name);
-      rb_iv_set(self, "@name", v_name);
-   }
-   else{
-      rb_iv_set(self, "@name", Qnil);
-   }
+  v_new_hash = rb_hash_aref(v_hash, v_key);
 
-   if(!NIL_P(v_instance))
-      rb_iv_set(self, "@instance", v_instance);
-   else
-      rb_iv_set(self, "@instance", Qnil);
+  if(NIL_P(v_new_hash)){
+    v_new_hash = rb_hash_new();
+    rb_hash_aset(v_hash, v_key, v_new_hash);    
+  }
 
-   return self;
+  return v_new_hash;
 }
 
 /*
@@ -75,141 +92,146 @@ VALUE ks_init(int argc, VALUE* argv, VALUE self){
  * The more specific your criterion, the less data you will receive.
  */
 VALUE ks_record(VALUE self){
-   volatile VALUE v_m_hash, v_i_hash, v_n_hash, v_s_hash;
-   KstatStruct* ptr;
-   kstat_io_t kio;
-   kstat_timer_t kt;
-
-   char* module;
-   char* name;
-   int instance = -1; /* -1 represents all instances (the default) */
-
-   VALUE v_module, v_instance, v_name;
-
-   Data_Get_Struct(self,KstatStruct,ptr);
-
-   v_m_hash = rb_hash_new(); /* Module name is key, holds v_i_hashes   */
-   v_i_hash = rb_hash_new(); /* Instance name is key, holds v_n_hashes */
-   v_n_hash = rb_hash_new(); /* Name is key, holds v_s_hashes          */
-
-   v_module   = rb_iv_get(self, "@module");
-   v_instance = rb_iv_get(self, "@instance");
-   v_name     = rb_iv_get(self, "@name");
-
-   /* Module is NULL by default (i.e. all modules are returned) */
-   if(NIL_P(v_module))
-      module = NULL;
-   else
-      module = StringValuePtr(v_module);
-
-   /* Instance defaults to -1 (i.e. all instances are returned) */
-   if(!NIL_P(v_instance))
-      instance = NUM2INT(v_instance);
-
-   /* Name is NULL by default (i.e. all names are returned) */
-   if(NIL_P(v_name))
-      name = NULL;
-   else
-      name = StringValuePtr(v_name);
-
-   /* A failure probably means the module, instance or name doesn't exist */
-   if((ptr->kc = kstat_open()) == NULL)
-      rb_raise(cKstatError,"kstat_open() failure: %s", strerror(errno));
-
-   /*
-    * Traverse the kstat chain, looking for matches based on supplied data.
-    * A failure likely means a non-existant module or name was provided.
-    */
-   if((ptr->ksp = kstat_lookup(ptr->kc, module, instance, name)) == NULL)
-      rb_raise(cKstatError,"kstat_lookup() failure: %s", strerror(errno));
-
-   /* Sync the chain with the kernel */
-   kstat_chain_update(ptr->kc);
-
-   while(ptr->ksp){
-
-      /* If a module is specified, ignore modules that don't match */
-      if( (module) && (strcmp(module,ptr->ksp->ks_module)) ){
-         ptr->ksp = ptr->ksp->ks_next;
-         continue;
-      }
-
-      /* If an instance is specified, ignore instances that don't match */
-      if( (instance != -1) && (instance != ptr->ksp->ks_instance) ){
-         ptr->ksp = ptr->ksp->ks_next;
-         continue;
-      }
-
-      /* If a name is specified, ignore names that don't match */
-      if( (name) && (strcmp(name,ptr->ksp->ks_name)) ){
-         ptr->ksp = ptr->ksp->ks_next;
-         continue;
-      }
-
-      /* Call the appropriate data mapper based on ks_type */
-      switch(ptr->ksp->ks_type){
-         case KSTAT_TYPE_NAMED:
-            kstat_read(ptr->kc, ptr->ksp, NULL);
-            v_s_hash = map_named_data_type(ptr->ksp);
-            break;
-         case KSTAT_TYPE_IO:
-            kstat_read(ptr->kc, ptr->ksp, &kio);
-            v_s_hash = map_io_data_type(&kio);
-            break;
-         case KSTAT_TYPE_TIMER:
-            kstat_read(ptr->kc, ptr->ksp, &kt);
-            v_s_hash = map_timer_data_type(&kt);
-         case KSTAT_TYPE_INTR:
-            kstat_read(ptr->kc, ptr->ksp, NULL);
-            v_s_hash = map_intr_data_type(ptr->ksp);
-            break;
-         case KSTAT_TYPE_RAW:
-            kstat_read(ptr->kc, ptr->ksp, NULL);
-            v_s_hash = map_raw_data_type(ptr->ksp);   
-            break;
-         default:
-            rb_raise(cKstatError,"Unknown data record type");
-      }
-
-      rb_hash_aset(v_n_hash, rb_str_new2(ptr->ksp->ks_name), v_s_hash);
-      rb_hash_aset(v_i_hash, INT2FIX(ptr->ksp->ks_instance),  v_n_hash);
-      rb_hash_aset(v_m_hash, rb_str_new2(ptr->ksp->ks_module), v_i_hash);
+  volatile VALUE v_m_hash, v_i_hash, v_n_hash, v_s_hash;
+  KstatStruct* ptr;
+  kstat_io_t kio;
+  kstat_timer_t kt;
+  char* module;
+  char* name;
+  int instance = -1; // -1 represents all instances (the default)
+
+  VALUE v_module, v_instance, v_name;
+
+  Data_Get_Struct(self,KstatStruct,ptr);
+
+  v_m_hash = rb_hash_new(); // Module name is key, holds v_i_hashes
+
+  v_module   = rb_iv_get(self, "@module");
+  v_instance = rb_iv_get(self, "@instance");
+  v_name     = rb_iv_get(self, "@name");
+
+  // Module is NULL by default (i.e. all modules are returned)
+  if(NIL_P(v_module))
+    module = NULL;
+  else
+    module = StringValuePtr(v_module);
+
+  // Instance defaults to -1 (i.e. all instances are returned)
+  if(!NIL_P(v_instance))
+    instance = NUM2INT(v_instance);
+
+  // Name is NULL by default (i.e. all names are returned)
+  if(NIL_P(v_name))
+    name = NULL;
+  else
+    name = StringValuePtr(v_name);
+
+  // A failure probably means the module, instance or name doesn't exist
+  if((ptr->kc = kstat_open()) == NULL)
+    rb_raise(cKstatError, "kstat_open() failure: %s", strerror(errno));
+
+  /*
+   * Traverse the kstat chain, looking for matches based on supplied data.
+   * A failure likely means a non-existant module or name was provided.
+   */
+  if((ptr->ksp = kstat_lookup(ptr->kc, module, instance, name)) == NULL)
+    rb_raise(cKstatError, "kstat_lookup() failure: %s", strerror(errno));
+
+  // Sync the chain with the kernel
+  if(kstat_chain_update(ptr->kc) == -1)
+    rb_raise(cKstatError, "kstat_chain_update() failure: %s", strerror(errno));
+
+  while(ptr->ksp){
+    // If a module is specified, ignore modules that don't match
+    if((module) && (strcmp(module,ptr->ksp->ks_module))){
+      ptr->ksp = ptr->ksp->ks_next;
+      continue;
+    }
 
+    // If an instance is specified, ignore instances that don't match
+    if((instance != -1) && (instance != ptr->ksp->ks_instance)){
       ptr->ksp = ptr->ksp->ks_next;
-   }
+      continue;
+    }
 
-   return v_m_hash;
+    // If a name is specified, ignore names that don't match
+    if((name) && (strcmp(name,ptr->ksp->ks_name))){
+      ptr->ksp = ptr->ksp->ks_next;
+      continue;
+    }
+
+    // Call the appropriate data mapper based on ks_type
+    switch(ptr->ksp->ks_type){
+      case KSTAT_TYPE_NAMED:
+        kstat_read(ptr->kc, ptr->ksp, NULL);
+        v_s_hash = map_named_data_type(ptr->ksp);
+        break;
+      case KSTAT_TYPE_IO:
+        kstat_read(ptr->kc, ptr->ksp, &kio);
+        v_s_hash = map_io_data_type(&kio);
+        break;
+      case KSTAT_TYPE_TIMER:
+        kstat_read(ptr->kc, ptr->ksp, &kt);
+        v_s_hash = map_timer_data_type(&kt);
+      case KSTAT_TYPE_INTR:
+        kstat_read(ptr->kc, ptr->ksp, NULL);
+        v_s_hash = map_intr_data_type(ptr->ksp);
+        break;
+      case KSTAT_TYPE_RAW:
+        kstat_read(ptr->kc, ptr->ksp, NULL);
+        v_s_hash = map_raw_data_type(ptr->ksp);   
+        break;
+      default:
+        rb_raise(cKstatError,"Unknown data record type");
+    }
+
+    /* Set the class for this set of statistics */
+    if(ptr->ksp->ks_class)
+      rb_hash_aset(v_s_hash, rb_str_new2("class"), rb_str_new2(ptr->ksp->ks_class));
+
+    v_i_hash = get_hash_for_key(v_m_hash, rb_str_new2(ptr->ksp->ks_module));
+    v_n_hash = get_hash_for_key(v_i_hash, INT2FIX(ptr->ksp->ks_instance));
+
+    rb_hash_aset(v_n_hash, rb_str_new2(ptr->ksp->ks_name), v_s_hash);
+    rb_hash_aset(v_i_hash, INT2FIX(ptr->ksp->ks_instance),  v_n_hash);
+    rb_hash_aset(v_m_hash, rb_str_new2(ptr->ksp->ks_module), v_i_hash);
+
+    ptr->ksp = ptr->ksp->ks_next;
+  }
+
+  return v_m_hash;
 }
 
 void Init_kstat(){
-   VALUE mSolaris, cKstat;
+  VALUE mSolaris, cKstat;
+
+  /* The Solaris module only serves as a toplevel namespace */
+  mSolaris = rb_define_module("Solaris");
 
-   /* The Solaris module only serves as a toplevel namespace */
-   mSolaris = rb_define_module("Solaris");
+  /* The Kstat class encapsulates kstat (kernel statistics) information */
+  cKstat = rb_define_class_under(mSolaris, "Kstat", rb_cObject);
 
-   /* The Kstat class encapsulates kstat (kernel statistics) information */
-   cKstat  = rb_define_class_under(mSolaris, "Kstat", rb_cObject);
+  /* The Kstat::Error class is raised if any of the Kstat methods fail */
+  cKstatError = rb_define_class_under(cKstat, "Error", rb_eStandardError);
 
-   /* The Kstat::Error class is raised if any of the Kstat methods fail */
-   cKstatError = rb_define_class_under(cKstat, "Error", rb_eStandardError);
+  rb_define_alloc_func(cKstat, ks_allocate);
 
-   rb_define_alloc_func(cKstat, ks_allocate);
+  // Instance Methods
 
-   /* Instance Methods */
-   rb_define_method(cKstat, "initialize", ks_init, -1);
-   rb_define_method(cKstat, "record", ks_record, 0);
+  rb_define_method(cKstat, "initialize", ks_init, -1);
+  rb_define_method(cKstat, "record", ks_record, 0);
 
-   /* Kernel module */
-   rb_define_attr(cKstat, "module", 1, 1);
+  // Kernel module
+  rb_define_attr(cKstat, "module", 1, 1);
 
-   /* Index of module entity */
-   rb_define_attr(cKstat, "instance", 1, 1);
+  // Index of module entity
+  rb_define_attr(cKstat, "instance", 1, 1);
 
-   /* Unique name within module */
-   rb_define_attr(cKstat, "name", 1, 1);
+  // Unique name within module
+  rb_define_attr(cKstat, "name", 1, 1);
 
-   /* 1.0.1: The version of the solaris-kstat library */
-   rb_define_const(cKstat, "VERSION", rb_str_new2(SOLARIS_KSTAT_VERSION));
+  /* 1.0.2: The version of the solaris-kstat library */
+  rb_define_const(cKstat, "VERSION", rb_str_new2(SOLARIS_KSTAT_VERSION));
 }
 
 #ifdef __cplusplus