mincore 0.0.8 → 0.0.9.pre

data/.gitignore

@@ -0,0 +1,5 @@
+writable_tmp_dir/
+scratch
+*.gem
+Gemfile.lock
+gems/

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+before_script: ./bin/ci/before_build.sh
+
+script: "bundle exec rake test"
+
+rvm:
+  - 1.9.3
+  - 1.8.7
+  - 2.0.0-p0
+  - 2.0.0-p247
+
+gemfile:
+  - Gemfile
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'RubyInline', '>= 3.10.1', :require => 'inline'

data/README.md

@@ -0,0 +1,30 @@
+ruby-mincore
+============
+[![Gem Version](https://badge.fury.io/rb/mincore.png)](http://badge.fury.io/rb/mincore)
+[![Build Status](https://travis-ci.org/noushi/ruby-mincore.png?branch=master)](https://travis-ci.org/noushi/ruby-mincore)
+[![Code Climate](https://codeclimate.com/github/noushi/ruby-mincore.png)](https://codeclimate.com/github/noushi/ruby-mincore)
+[![Dependency Status](https://gemnasium.com/noushi/ruby-mincore.png)](https://gemnasium.com/noushi/ruby-mincore)
+
+Ruby bindings for Linux cache manipulation.
+
+This project is heavily inspired from [Feh/nocache](http://github.com/Feh/nocache).
+
+
+Status & Limitations
+====================
+
+Currently, the File class is extended as such:
+- `mincore(filename)` is exported to Ruby in the form of an array of booleans corresponding to each page of the file.
+- `cachedel(filename, count=1)` calls `posix_fadvise(2)` to purge all file pages from the cache
+- `PAGESIZE` is a simple helper that returns the value of PAGESIZE (4KB on Intel)
+
+The bindings are implemented using Ruby Inline, instead of the classic mkmf ext C.
+
+There is a gem module generated, and the code is still beta.
+
+Since `File.cachedel()` isn't guaranteed to work (no matter how many time you call it), the `test_cachedel_non_empty_file` most always succeeds without properly asserting that `posix_fadvise()` has worked.
+
+Also, the tests use a `./writable_tmp_dir/` directory to store the temporary test files. `/tmp` can't be used since it's 
+usually a ramfs, and files will always be in cache, until they're deleted.
+
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake/testtask'
+require 'rake/clean'
+
+WORKDIR='writable_tmp_dir'
+
+CLEAN.include("#{WORKDIR}/*")
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+
+
+task :default => :test
+

data/TODO

@@ -0,0 +1,20 @@
+- Integrate mincore functions fully in the File class : File.mincore
+   should be an instance method operating on the file instance
+   => use GetOpenFile macro from io.h and keep the class method form
+   as well:
+   https://github.com/ruby/ruby/blob/4c2304f0004e9f1784540f3d36976aad9eab1f68/ext/socket/init.c#L181
+   https://github.com/ruby/ruby/blob/4c2304f0004e9f1784540f3d36976aad9eab1f68/ext/socket/init.c#L204
+   https://github.com/ruby/ruby/blob/4c2304f0004e9f1784540f3d36976aad9eab1f68/ext/socket/init.c#L208
+
+- Generate proper Ruby exceptions instead of perror/exit(1)
+- Fix the documentation
+- Find a better way to manage the gem: auto-increment version...
+- Find a (more!) proper test case for cachedel 
+
+POSTPONED
+=========
+- fstat() on each mincore() call is most probably overkill: we don't
+   need to read file status just to know if it's empty or not a
+   regular file, but I need to know the pageinfo array size and if I
+   receive the file name from inotify, its metadata should already be
+   in RAM...

data/bin/ci/before_build.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+gem install bundler
+

data/mincore.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = 'mincore'
+  s.version     = '0.0.9.pre'
+  s.date        = '2013-11-10'
+
+  s.homepage    = 'http://github.com/noushi/ruby-mincore'
+  s.summary     = "Ruby bindings for Linux cache manipulation"
+  s.description = <<-DESC
+    micore provides Ruby bindings for Linux cache manipulation, 
+    including cache inspection and deletion for a specific file.
+  DESC
+  s.license       = 'GPL-2'
+
+  s.authors     = ["Reda NOUSHI"]
+  s.email       = 'reda_noushi@yahoo.com'
+
+  s.files       = `git ls-files`.split($/)
+  #s.files       = ["lib/mincore.rb"]
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_runtime_dependency "RubyInline", [">= 3.10.1"]
+  s.add_development_dependency "RubyInline", [">= 3.10.1"]
+end

data/test/mincore_test.rb

@@ -0,0 +1,160 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+require 'fileutils'
+require 'mincore'
+
+class TestableFile
+  attr_reader :path, :size, :name
+  
+  def initialize(size_kb=100, path='/tmp')
+    @path = path
+    FileUtils.mkdir_p(@path) unless File.directory?(@path)
+
+    @size_kb = size_kb
+
+    @name = "#{@path}/testable_file.#{rand(1000000)}"
+    FileUtils.touch(@name)  
+  end
+  
+  def numpages
+    File.open(@name).numpages
+  end  
+
+  def cli_fill
+    @size_kb.times do 
+      s = "s" * 1024
+      `echo -n #{s} >>#{@name}`
+    end
+  end
+
+  def ruby_fill
+    File.open(@name, "w") do |f|
+#      s = Random.new.bytes(1024)
+      s = "s" * 1024
+      @size_kb.times do 
+        f.write s
+      end
+    end
+  end
+  
+  alias_method :fill, :ruby_fill
+#  alias_method :fill, :cli_fill
+
+  def read(pages=@size_kb)
+    if pages == @size_kb
+      `cat #{@name} >/dev/null`
+    else
+      4.times do 
+        File.open(@name, "r").each do |line|
+          line
+        end
+      end
+    end
+  end
+
+  def delete
+    File.delete(@name)
+  end
+
+  def describe
+    "file #{@name} of current size #{File.stat(@name).size}"
+  end
+
+end
+
+class MincoreTest < Test::Unit::TestCase
+  def test_pagesize
+    pagesize = `getconf PAGESIZE`.to_i
+    assert_equal pagesize, File.PAGESIZE
+  end
+
+  def test_numpages
+    size_kb = rand(1000)
+    f = TestableFile.new(size_kb, "./writable_tmp_dir")
+    pagesize = File.PAGESIZE
+    
+    numpages = (File.open(f.name).stat.size*1024 + pagesize -1 ) / pagesize
+    
+    assert_equal numpages, f.numpages
+
+    f.delete
+  end
+  
+  def test_mincore_empty_file
+    _generic_mincore_test 0, [0,[]], :delete => true
+  end
+
+  def test_mincore_non_empty_file
+    _generic_mincore_test 40, :delete => true
+  end
+
+  def test_cachedel_empty_file
+    _generic_cachedel_test 0
+  end
+
+  def test_cachedel_non_empty_file
+    _generic_cachedel_test 400
+  end
+
+
+  def _generic_mincore_test(size_kb, result=nil, delete=true)
+    size = size_kb * 1024
+
+    f = TestableFile.new(size_kb, "./writable_tmp_dir")
+
+    retcode, pieces = File.mincore(f.name)
+    
+    assert_equal [0, []], [retcode, pieces] 
+
+    return f if size == 0
+    
+    f.fill
+
+    retcode, pieces = File.mincore(f.name)
+
+    assert_equal retcode, 0, f.describe
+    assert_equal [[true, f.numpages]], pieces.tinify
+
+    f.delete if delete
+
+    return f
+  end
+  
+  def _generic_cachedel_test(size_kb)
+    f=_generic_mincore_test(size_kb, nil, false)
+    
+    f.read
+
+    retcode, pieces = File.mincore(f.name)
+
+    assert_equal retcode, 0, f.describe
+    assert_equal [true]*(f.numpages), pieces
+
+    ret = File.cachedel(f.name, 30)
+    assert_equal 0, ret, f.describe
+    
+    #`cachedel #{f.name}`
+   
+    retcode, pieces = File.mincore(f.name)
+
+    assert_equal retcode, 0, f.describe
+
+    if size_kb == 0
+      ret = []
+      assert_equal ret, pieces.tinify, f.describe
+    else
+      ret = [[true, f.numpages]]
+      if ret != pieces.tinify #The code/test is still valid even if the file is fully kept cached
+        assert_not_equal ret, pieces.tinify, f.describe
+      end
+    end
+    
+    f.delete
+
+  end
+
+
+  
+  
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+Dir.chdir File.expand_path("../../", __FILE__)
+$LOAD_PATH.unshift ".", "lib", "test"
+
+require "test/unit"
+
+
+class Array
+  def tinify
+    cur = nil
+    ret = []
+    self.each_index { |x| 
+      if x == 0
+        cur = self[x]
+        ret << [self[x],1]
+        next 
+      end
+      
+      if cur == self[x]
+#        puts "<#{ret.last}>"
+        ret[-1][1] += 1
+      else
+        ret << [self[x],1]
+      end
+
+      cur = self[x]
+    }
+    ret
+  end
+end
+
+

data/test/tinify_test.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ArrayTinifyTest < Test::Unit::TestCase
+  def test_true
+    a = [true]*10
+    
+#    puts "#{a.tinify}"
+    assert_equal [[true, 10]], a.tinify
+  end
+  
+  def test_true_false
+    a = [[true]*10, [false]*10].flatten
+    
+    assert_equal [[true, 10], [false, 10]], a.tinify
+  end
+end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: mincore
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: 
+  hash: -2045603333
+  prerelease: 6
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  - pre
+  version: 0.0.9.pre
 platform: ruby
 authors: 
 - Reda NOUSHI
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-11-09 00:00:00 Z
+date: 2013-11-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: RubyInline
@@ -49,7 +50,7 @@ dependencies:
         version: 3.10.1
   type: :development
   version_requirements: *id002
-description: Provides cache inspection and deletion for a specific file.
+description: "    micore provides Ruby bindings for Linux cache manipulation, \n    including cache inspection and deletion for a specific file.\n"
 email: reda_noushi@yahoo.com
 executables: []
 
@@ -58,10 +59,21 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- TODO
+- bin/ci/before_build.sh
 - lib/mincore.rb
+- mincore.gemspec
+- test/mincore_test.rb
+- test/test_helper.rb
+- test/tinify_test.rb
 homepage: http://github.com/noushi/ruby-mincore
 licenses: 
-- GPLv2
+- GPL-2
 post_install_message: 
 rdoc_options: []
 
@@ -79,12 +91,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
@@ -92,5 +106,7 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for Linux cache manipulation
-test_files: []
-
+test_files: 
+- test/mincore_test.rb
+- test/test_helper.rb
+- test/tinify_test.rb