hitimes 1.3.0-x64-mingw32

data/Rakefile

@@ -0,0 +1,28 @@
+# vim: syntax=ruby
+load 'tasks/this.rb'
+
+This.name     = "hitimes"
+This.author   = "Jeremy Hinegardner"
+This.email    = "jeremy@copiousfreetime.org"
+This.homepage = "http://github.com/copiousfreetime/#{ This.name }"
+
+This.ruby_gemspec do |spec|
+  spec.add_development_dependency( 'rake'         , '~> 12.0')
+  spec.add_development_dependency( 'minitest'     , '~> 5.5' )
+  spec.add_development_dependency( 'rdoc'         , '~> 5.0'  )
+  spec.add_development_dependency( 'json'         , '~> 2.0' )
+  spec.add_development_dependency( 'rake-compiler', '~> 1.0' )
+  spec.add_development_dependency( 'rake-compiler-dock', '~> 0.6' )
+  spec.add_development_dependency( 'simplecov'    , '~> 0.14' )
+
+  spec.extensions.concat This.extension_conf_files
+  spec.license = "ISC"
+end
+
+This.java_gemspec( This.ruby_gemspec ) do |spec|
+  spec.extensions.clear
+  spec.files << "lib/hitimes/hitimes.jar"
+end
+
+load 'tasks/default.rake'
+load 'tasks/extension.rake'

data/examples/benchmarks.rb

@@ -0,0 +1,113 @@
+require 'benchmark'
+require 'time'
+
+#
+# this is all here in case this example is run from the examples directory
+#
+begin
+  require 'hitimes'
+rescue LoadError => le
+  ext_path = File.expand_path( File.join( File.dirname( __FILE__ ), "..", "ext" ) )
+  lib_path = File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) )
+  if $:.include?( ext_path ) then
+    raise le
+  end
+  $: << ext_path
+  $: << lib_path
+  retry
+end
+
+#----------------------------------------------------------------------
+# test program to look at the performance sampling time durations using
+# different methods
+#----------------------------------------------------------------------
+
+include Benchmark
+
+#
+# Normal apprach to Interval usage
+#
+def hitimes_duration_i1
+  i = Hitimes::Interval.new
+  i.start
+  i.stop
+end
+
+#
+# Use the easy access method to start stop an interval
+#
+def hitimes_duration_i2
+  Hitimes::Interval.now.stop
+end
+
+#
+# Use a new timer each time
+#
+def hitimes_duration_t1
+  Hitimes::TimedMetric.now('duration_t1').stop
+end
+
+#
+# reuse the same timer over and over
+#
+HT2= Hitimes::TimedMetric.new( 'duration_t2' )
+def hitimes_duration_t2
+  HT2.start
+  HT2.stop
+end
+
+HT3 = Hitimes::TimedMetric.new( 'duration_t3' )
+def hitimes_duration_t3
+  HT3.measure { nil }
+end
+
+#
+# Check out the speed of the TimedValueMetric too
+#
+def hitimes_duration_tv1
+  Hitimes::TimedValueMetric.now( 'duration_tv1' ).stop( 42 )
+end
+
+HTV2 = Hitimes::TimedValueMetric.new( 'duration_tv2' )
+def hitimes_duration_tv2
+  HTV2.start
+  HTV2.stop( 42 )
+end
+
+HTV3 = Hitimes::TimedValueMetric.new( 'duration_tv3' )
+def hitimes_duration_tv3
+  HTV3.measure( 42 ) { nil }
+end
+
+#
+# use the Struct::Tms values and return  the difference in User time between 2 
+# successive calls
+#
+def process_duration
+  t1 = Process.times.utime
+  Process.times.utime - t1
+end
+
+#
+# Take 2 times and subtract one from the other
+#
+def time_duration
+  t1 = Time.now.to_f
+  Time.now.to_f - t1
+end
+  
+
+puts "Testing time sampling 100,000 times"
+
+bm(30) do |x|
+  x.report("Process")                     { 100_000.times { process_duration } }
+  x.report("Time")                        { 100_000.times { time_duration    } }
+  x.report("Hitimes::TimedMetric 1")      { 100_000.times { hitimes_duration_t1 } }
+  x.report("Hitimes::TimedMetric 2")      { 100_000.times { hitimes_duration_t2 } }
+  x.report("Hitimes::TimedMetric 3")      { 100_000.times { hitimes_duration_t3 } }
+  x.report("Hitimes::Interval 1")         { 100_000.times { hitimes_duration_i1 } }
+  x.report("Hitimes::Interval 2")         { 100_000.times { hitimes_duration_i2 } }
+  x.report("Hitimes::TimedValueMetric 1") { 100_000.times { hitimes_duration_tv1 } }
+  x.report("Hitimes::TimedValueMetric 2") { 100_000.times { hitimes_duration_tv2 } }
+  x.report("Hitimes::TimedValueMetric 3") { 100_000.times { hitimes_duration_tv3 } }
+end

data/examples/stats.rb

@@ -0,0 +1,31 @@
+#
+# this is all here in case this example is run from the examples directory
+#
+begin
+  require 'hitimes'
+rescue LoadError => le
+  %w[ ext lib ].each do |p|
+    path = File.expand_path( File.join( File.dirname( __FILE__ ), "..", p ) )
+    if $:.include?( path ) then
+      raise le
+    end
+    $: << path
+  end
+  retry
+end
+
+s = Hitimes::Stats.new
+dir = ARGV.shift || Dir.pwd
+Dir.entries( dir ).each do |entry|
+  fs = File.stat( entry )
+  if fs.file? then
+    s.update( fs.size )
+  end
+end
+
+Hitimes::Stats::STATS.each do |m|
+  puts "#{m.rjust(6)} : #{s.send( m ) }"
+end
+
+puts s.to_hash.inspect
+

data/ext/hitimes/c/extconf.rb

@@ -0,0 +1,24 @@
+require 'rbconfig'
+require 'mkmf'
+
+if RbConfig::CONFIG['host_os'] =~ /darwin/ then
+  $CFLAGS += " -DUSE_INSTANT_OSX=1 -Wall"
+  $LDFLAGS += " -framework CoreServices"
+elsif RbConfig::CONFIG['host_os'] =~ /win(32|64)/ or RbConfig::CONFIG['host_os'] =~ /mingw/ then
+  $CFLAGS += " -DUSE_INSTANT_WINDOWS=1"
+else
+  if have_library("rt", "clock_gettime") then
+    $CFLAGS += " -DUSE_INSTANT_CLOCK_GETTIME=1"
+  elsif have_library("c", "clock_gettime") then
+    $CFLAGS += " -DUSE_INSTANT_CLOCK_GETTIME=1"
+  else
+    raise NotImplementedError, <<-_
+Unable to find the function 'clock_gettime' in either libc or librt.
+Please file an issue at https://github.com/copiousfreetime/hitimes.
+_
+  end
+end
+
+# put in a different location if on windows so we can have fat binaries
+subdir = RUBY_VERSION.gsub(/\.\d+$/,'')
+create_makefile("hitimes/#{subdir}/hitimes")

data/ext/hitimes/c/hitimes.c

@@ -0,0 +1,37 @@
+#include <ruby.h>
+#include "hitimes_interval.h"
+
+/* Module and Classes */
+VALUE mH;           /* module Hitimes            */
+VALUE eH_Error;     /* class  Hitimes::Error     */
+
+
+/**
+ * call-seq:
+ *    Hitimes.raw_instant -> Integer
+ *
+ * Return the raw instant value from the operating system
+ */
+VALUE hitimes_instant_raw( )
+{
+    unsigned long long i = (unsigned long long)hitimes_get_current_instant( );
+
+    return ULL2NUM(i);
+}
+
+/*
+ * Document-class: Hitimes::Error
+ *
+ * General error class for the Hitimes module
+ */
+void Init_hitimes( )
+{
+    mH = rb_define_module("Hitimes");
+
+    eH_Error = rb_define_class_under(mH, "Error", rb_eStandardError);
+    rb_define_const( mH, "INSTANT_CONVERSION_FACTOR", DBL2NUM( HITIMES_INSTANT_CONVERSION_FACTOR ));
+    rb_define_module_function( mH, "raw_instant", hitimes_instant_raw, 0 );
+
+    Init_hitimes_interval();
+    Init_hitimes_stats( );
+}

data/ext/hitimes/c/hitimes_instant_clock_gettime.c

@@ -0,0 +1,28 @@
+#ifdef USE_INSTANT_CLOCK_GETTIME
+
+#include "hitimes_interval.h"
+
+#include <time.h>
+#ifndef CLOCK_MONOTONIC
+#  include <sys/time.h>
+#  ifndef CLOCK_MONOTONIC
+#    ifdef __linux__
+#      include <linux/time.h>
+#    endif
+#  endif
+#endif
+
+hitimes_instant_t hitimes_get_current_instant( )
+{
+    struct timespec time;
+    int rc;
+
+    rc = clock_gettime( CLOCK_MONOTONIC, &time);
+    if ( 0 != rc )  {
+        char* e = strerror( rc );
+        rb_raise(eH_Error, "Unable to retrieve time for CLOCK_MONOTONIC :  %s", e );
+    }
+
+    return ( ( NANOSECONDS_PER_SECOND * (long)time.tv_sec ) + time.tv_nsec );
+}
+#endif

data/ext/hitimes/c/hitimes_instant_osx.c

@@ -0,0 +1,45 @@
+#ifdef USE_INSTANT_OSX
+
+#include "hitimes_interval.h"
+#include <mach/mach.h>
+#include <mach/mach_time.h>
+
+/* All this OSX code is adapted from http://developer.apple.com/library/mac/#qa/qa1398/_index.html */
+
+/*
+ * returns the conversion factor, this value is used to convert
+ * the value from hitimes_get_current_instant() into seconds
+ */
+long double hitimes_instant_conversion_factor()
+{
+    static mach_timebase_info_data_t  s_timebase_info;
+    static long double                conversion_factor;
+    static uint64_t                   nano_conversion;
+
+    /**
+     * If this is the first time we've run, get the timebase.
+     * We can use denom == 0 to indicate that s_timebase_info is
+     * uninitialised because it makes no sense to have a zero
+     * denominator is a fraction.
+     */
+
+    if ( s_timebase_info.denom == 0 ) {
+        mach_timebase_info(&s_timebase_info);
+        nano_conversion   = s_timebase_info.numer / s_timebase_info.denom;
+        conversion_factor = (long double) (nano_conversion) * (1e9l);
+    }
+
+    return conversion_factor;
+}
+
+/*
+ * returns the mach absolute time, which has no meaning outside of a conversion
+ * factor.
+ */
+hitimes_instant_t hitimes_get_current_instant()
+{
+    return mach_absolute_time();
+}
+
+
+#endif

data/ext/hitimes/c/hitimes_instant_windows.c

@@ -0,0 +1,27 @@
+#ifdef USE_INSTANT_WINDOWS
+
+#include "hitimes_interval.h"
+
+
+/*
+ * returns the conversion factor, this value is used to convert
+ * the value from hitimes_get_current_instant() into seconds
+ */
+long double hitimes_instant_conversion_factor()
+{
+    LARGE_INTEGER ticks_per_second;
+    QueryPerformanceFrequency( &ticks_per_second );
+    return (double)ticks_per_second.QuadPart;
+}
+
+/*
+ * returns the number of ticks
+ */
+hitimes_instant_t hitimes_get_current_instant()
+{
+    LARGE_INTEGER tick;
+    QueryPerformanceCounter(&tick);
+    return (hitimes_instant_t)tick.QuadPart;
+}
+
+#endif

data/ext/hitimes/c/hitimes_interval.c

@@ -0,0 +1,370 @@
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+#include "hitimes_interval.h"
+
+/* Modules and Classes -- defined here */
+VALUE cH_Interval;         /* class  Hitimes::Interval  */
+
+/**
+ * Allocator and Deallocator for Interval classes
+ */
+
+VALUE hitimes_interval_free(hitimes_interval_t* i) 
+{
+    xfree( i );
+    return Qnil;
+}
+
+VALUE hitimes_interval_alloc(VALUE klass)
+{
+    VALUE obj;
+    hitimes_interval_t* i = xmalloc( sizeof( hitimes_interval_t ) );
+
+    i->start_instant = 0L;
+    i->stop_instant  = 0L;
+    i->duration      = -1.0l;
+
+    obj = Data_Wrap_Struct(klass, NULL, hitimes_interval_free, i);
+    return obj;
+}
+
+/**
+ * call-seq:
+ *    Interval.now -> Interval
+ *
+ * Create an interval that has already started
+ */
+VALUE hitimes_interval_now( )
+{
+    VALUE obj;
+    hitimes_interval_t *i = xmalloc( sizeof( hitimes_interval_t ) );
+
+    i->start_instant = hitimes_get_current_instant( );
+    i->stop_instant  = 0L;
+    i->duration      = -1.0l;
+
+    obj = Data_Wrap_Struct(cH_Interval, NULL, hitimes_interval_free, i);
+
+    return obj;
+}
+
+/**
+ * call-seq:
+ *    Interval.measure {  }  -> Float
+ *
+ * Times the execution of the block returning the number of seconds it took
+ */
+VALUE hitimes_interval_measure( )
+{
+    hitimes_instant_t before;
+    hitimes_instant_t after;
+    long double       duration;
+
+    if ( !rb_block_given_p() ) {
+        rb_raise(eH_Error, "No block given to Interval.measure" );
+    }
+
+    before = hitimes_get_current_instant( );
+    rb_yield( Qnil );
+    after  = hitimes_get_current_instant( );
+
+    duration = ( after - before ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+    return rb_float_new( duration );
+}
+
+/**
+ * call-seq:
+ *    interval.split -> Interval
+ *
+ * Immediately stop the current interval and start a new interval that has a
+ * start_instant equivalent to the stop_interval of self.
+ */
+VALUE hitimes_interval_split( VALUE self )
+{
+    hitimes_interval_t *first;
+    hitimes_interval_t *second = xmalloc( sizeof( hitimes_interval_t ) );
+    VALUE              obj;
+
+    Data_Get_Struct( self, hitimes_interval_t, first );
+    first->stop_instant = hitimes_get_current_instant( );
+
+    second->start_instant = first->stop_instant;
+    second->stop_instant  = 0L;
+    second->duration      = -1.0l;
+
+    obj = Data_Wrap_Struct(cH_Interval, NULL, hitimes_interval_free, second);
+
+    return obj;
+}
+
+
+/**
+ * call-seq:
+ *    interval.start -> boolean
+ *
+ * mark the start of the interval.  Calling start on an already started
+ * interval has no effect.  An interval can only be started once.  If the
+ * interval is truely started +true+ is returned otherwise +false+.
+ */
+VALUE hitimes_interval_start( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE               rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( 0L == i->start_instant ) {
+      i->start_instant = hitimes_get_current_instant( );
+      i->stop_instant  = 0L;
+      i->duration      = -1.0l;
+
+      rc = Qtrue;
+    }
+
+    return rc;
+}
+
+
+/**
+ * call-seq:
+ *    interval.stop -> bool or Float
+ *
+ * mark the stop of the interval.  Calling stop on an already stopped interval
+ * has no effect.  An interval can only be stopped once.  If the interval is
+ * truely stopped then the duration is returned, otherwise +false+.
+ */
+VALUE hitimes_interval_stop( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE               rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( 0L == i->start_instant )  {
+        rb_raise(eH_Error, "Attempt to stop an interval that has not started" );
+    }
+
+    if ( 0L == i->stop_instant ) {
+      i->stop_instant = hitimes_get_current_instant( );
+      i->duration = ( i->stop_instant - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+      rc = rb_float_new( i->duration );
+    }
+
+    return rc;
+}
+
+/**
+ * call-seq:
+ *     interval.duration_so_far -> Float or false
+ *
+ * return how the duration so far.  This will return the duration from the time
+ * the Interval was started if the interval is running, otherwise it will return
+ * false.
+ */
+VALUE hitimes_interval_duration_so_far( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE               rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( 0L == i->start_instant ) {
+        return rc;
+    }
+
+    if ( 0L == i->stop_instant ) {
+        long double         d;
+        hitimes_instant_t now = hitimes_get_current_instant( );
+        d = ( now - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+        rc = rb_float_new( d );
+    }
+    return rc;
+}
+
+
+/**
+ * call-seq:
+ *    interval.started? -> boolean
+ *
+ * returns whether or not the interval has been started
+ */
+VALUE hitimes_interval_started( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+
+    return ( 0L == i->start_instant ) ? Qfalse : Qtrue;
+}
+
+
+/**
+ * call-seq:
+ *    interval.stopped? -> boolean
+ *
+ * returns whether or not the interval has been stopped
+ */
+VALUE hitimes_interval_stopped( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+
+    return ( 0L == i->stop_instant ) ? Qfalse : Qtrue;
+}
+
+/**
+ * call-seq:
+ *    interval.running? -> boolean
+ *
+ * returns whether or not the interval is running or not.  This means that it
+ * has started, but not stopped.
+ */
+VALUE hitimes_interval_running( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE              rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( ( 0L != i->start_instant ) && ( 0L == i->stop_instant ) ) {
+        rc = Qtrue;
+    }
+
+    return rc;
+}
+
+
+/** 
+ * call-seq:
+ *    interval.start_instant -> Integer
+ *
+ * The integer representing the start instant of the Interval.  This value
+ * is not useful on its own.  It is a platform dependent value.
+ */
+VALUE hitimes_interval_start_instant( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+   
+    return ULL2NUM( i->start_instant );
+}
+
+
+/** 
+ * call-seq:
+ *    interval.stop_instant -> Integer
+ *
+ * The integer representing the stop instant of the Interval.  This value
+ * is not useful on its own.  It is a platform dependent value.
+ */
+VALUE hitimes_interval_stop_instant( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+   
+    return ULL2NUM( i->stop_instant );
+}
+
+
+
+/**
+ * call-seq:
+ *    interval.duration -> Float
+ *    interval.to_f -> Float
+ *    interval.to_seconds -> Float
+ *    interval.length -> Float
+ *
+ * Returns the Float value of the interval, the value is in seconds.  If the
+ * interval has not had stop called yet, it will report the number of seconds
+ * in the interval up to the current point in time.
+ *
+ * Raises Error if duration is called on an interval that has not started yet.
+ */
+VALUE hitimes_interval_duration ( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+
+    /* raise an error if the internval is not started */
+    if ( 0L == i->start_instant )  {
+        rb_raise(eH_Error, "Attempt to report a duration on an interval that has not started" );
+    }
+
+
+    /**
+     * if stop has not yet been called, then return the amount of time so far
+     */
+    if ( 0L == i->stop_instant ) {
+        long double d;
+        hitimes_instant_t now = hitimes_get_current_instant( );
+        d = ( now - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+        return rb_float_new( d );
+    }
+
+    /*
+     * stop has been called, calculate the duration and save the result
+     */
+    if ( i->duration < 0.0 ) {
+        i->duration = ( i->stop_instant - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+    }
+
+    return rb_float_new( i->duration );
+}
+
+
+/**
+ * Document-class: Hitimes::Interval
+ *
+ * This is the lowest level timing mechanism available.  It allows for easy
+ * measuring based upon a block:
+ *
+ *   duration = Interval.measure { ... }
+ *
+ * Or measuring something specifically
+ *
+ *   interval = Interval.new
+ *   interval.start
+ *   duration = interval.stop
+ *
+ * Allocating and starting an interval can be done in one method call with
+ *
+ *   interval = Interval.now
+ *
+ * Interval is useful when you only need to track a single interval of time, or
+ * if you do not want to track statistics about an operation.
+ *
+ */
+void Init_hitimes_interval()
+{
+    mH = rb_define_module("Hitimes"); 
+   
+    cH_Interval = rb_define_class_under( mH, "Interval", rb_cObject );
+    rb_define_alloc_func( cH_Interval, hitimes_interval_alloc );
+
+    rb_define_module_function( cH_Interval, "now", hitimes_interval_now, 0 ); /* in hitimes_interval.c */
+    rb_define_module_function( cH_Interval, "measure", hitimes_interval_measure, 0 ); /* in hitimes_interval.c */
+
+    rb_define_method( cH_Interval, "duration",     hitimes_interval_duration, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "length",       hitimes_interval_duration, 0 ); 
+    rb_define_method( cH_Interval, "to_f",         hitimes_interval_duration, 0 );
+    rb_define_method( cH_Interval, "to_seconds",   hitimes_interval_duration, 0 );
+
+    rb_define_method( cH_Interval, "duration_so_far", hitimes_interval_duration_so_far, 0); /* in hitimes_interval.c */
+     
+    rb_define_method( cH_Interval, "started?",     hitimes_interval_started, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "running?",     hitimes_interval_running, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "stopped?",     hitimes_interval_stopped, 0 ); /* in hitimes_interval.c */
+
+    rb_define_method( cH_Interval, "start_instant", hitimes_interval_start_instant, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "stop_instant",  hitimes_interval_stop_instant, 0 ); /* in hitimes_interval.c */
+
+    rb_define_method( cH_Interval, "start", hitimes_interval_start, 0); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "stop",  hitimes_interval_stop, 0); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "split",  hitimes_interval_split, 0); /* in hitimes_interval.c */
+ 
+}