cache_stats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1afca83ac0a6f24aca3e9b173713e3f5f347166d
+  data.tar.gz: 707415500e04d774c91c0f20d80b16d49e85f4dd
+SHA512:
+  metadata.gz: 34ddc9a5ba28453968ed332ce053a6f6fa393dd2c9733f1eb2dc5f5d656867b621fc0b2e1e9984dbd6ab01c0826cfe9bfe351112b1f5bdc74ebf9c03a24bcfcb
+  data.tar.gz: 28b442f582ac5ba04c9825a609568052a8c9b7dfadc6699b2e37cd9c217719e634aa71b951d5688475020cf01939f6f0ceca95dc085c05eba20c7c24fbadda7a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rake-compiler"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeff McDonald
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# CacheStats
+
+View file cache residency of files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cache_stats'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_stats
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new("cache_stats")

data/cache_stats.gemspec

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_stats"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jeff McDonald"]
+  spec.email         = ["jeff@jmickeyd.com"]
+  spec.description   = "View file cache residency info"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/jmickeyd/cache_stats"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.extensions    = ["ext/cache_stats/extconf.rb"]
+end

data/examples/printcache.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'cache_stats'
+
+if ARGV.empty?
+  puts "USAGE: #{$0} <file1> [<file2> ...]"
+end
+
+ARGV.each do |filename|
+  stats = File.cache_stats filename
+  print '['
+  (0..stats.total_pages - 1).each do |page|
+    print stats[page] ? 'X' : ' '
+  end
+  print '] '
+  print "#{stats.cached_pages}/#{stats.total_pages}\n"
+end

data/ext/cache_stats/cache_stats.c

@@ -0,0 +1,143 @@
+#ifdef __linux__
+#define _LARGEFILE_SOURCE
+#define _FILE_OFFSET_BITS 64
+#endif
+
+#include <fcntl.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <sys/mman.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <ruby.h>
+#include <ruby/intern.h>
+
+VALUE cache_stats_class;
+uint64_t max_mapping_pages;
+int page_size;
+
+typedef struct
+{
+  uint64_t num_values;
+  uint64_t num_set_values;
+  char bitmap[0];
+} cache_stats_t;
+
+static void set_bit(cache_stats_t *stats, uint64_t position)
+{
+  stats->bitmap[position / 8] |= (1 << (position % 8));
+}
+
+static VALUE cache_stats_index(VALUE self, VALUE index)
+{
+  long i = NUM2LONG(index);
+  cache_stats_t *stats;
+  Data_Get_Struct(self, cache_stats_t, stats);
+  if (i >= stats->num_values || i < 0)
+    return Qnil;
+  return (stats->bitmap[i / 8] & (1 << (i % 8))) ? Qtrue : Qfalse;
+}
+
+static VALUE cache_stats_total_pages(VALUE self)
+{
+  cache_stats_t *stats;
+  Data_Get_Struct(self, cache_stats_t, stats);
+  return LONG2NUM(stats->num_values);
+}
+
+static VALUE cache_stats_cached_pages(VALUE self)
+{
+  cache_stats_t *stats;
+  Data_Get_Struct(self, cache_stats_t, stats);
+  return LONG2NUM(stats->num_set_values);
+}
+
+static VALUE file_cache_stats(VALUE self, VALUE file)
+{
+  VALUE result = Qnil;
+  struct stat file_stats;
+
+  const char *filename = StringValueCStr(file);
+  int fd = open(filename, O_RDONLY);
+  if (fd < 0) goto out;
+
+  if (fstat(fd, &file_stats)) goto close;
+
+  int file_pages = (file_stats.st_size + page_size - 1) / page_size;
+
+  cache_stats_t *stats = malloc(sizeof(cache_stats_t) + (file_pages + 7) / 8);
+  if (!stats) goto close;
+  memset(stats, 0, sizeof(cache_stats_t) + (file_pages + 7) / 8);
+  stats->num_values = file_pages;
+
+  uint64_t local_max_mapping_pages = max_mapping_pages;
+  char *override_env = getenv("CACHE_STATS_MAX_MAPPING_PAGES");
+  if (override_env)
+  {
+    uint64_t override = strtoll(override_env, NULL, 10);
+    if (override) local_max_mapping_pages = override;
+  }
+
+  size_t vec_size = (file_pages < local_max_mapping_pages) ? file_pages : local_max_mapping_pages;
+  char *vec = malloc(vec_size);
+  if (!vec) goto close;
+
+  uint64_t offset_pages = 0;
+  do
+  {
+    uint64_t mapping_pages = (file_pages - offset_pages < local_max_mapping_pages) ? file_pages - offset_pages : local_max_mapping_pages;
+
+    void *addr = mmap(NULL, mapping_pages * page_size, PROT_READ, MAP_SHARED, fd, offset_pages * page_size);
+    if (addr == MAP_FAILED) goto close;
+
+    if (mincore(addr, mapping_pages * page_size, vec))
+    {
+      munmap(addr, mapping_pages * page_size);
+      goto close;
+    }
+
+    for (int i = 0; i < mapping_pages; ++i)
+    {
+      if (vec[i] & 1)
+      {
+        stats->num_set_values++;
+        set_bit(stats, i + offset_pages);
+      }
+    }
+
+    munmap(addr, mapping_pages * page_size);
+    offset_pages += mapping_pages;
+  } while ( offset_pages < file_pages);
+
+  result = Data_Wrap_Struct(cache_stats_class, 0, free, stats);
+close:
+  close(fd);
+out:
+  return result;
+}
+
+void Init_cache_stats()
+{
+  if(sizeof(int *) == 4)
+  {
+    max_mapping_pages = 131072; //512MiB
+  }
+  else
+  {
+    max_mapping_pages = UINT64_MAX;
+  }
+
+  page_size = sysconf(_SC_PAGESIZE);
+
+  cache_stats_class = rb_define_class("CacheStats", rb_cObject);
+  rb_define_method(cache_stats_class, "total_pages", cache_stats_total_pages, 0);
+  rb_define_method(cache_stats_class, "cached_pages", cache_stats_cached_pages, 0);
+  rb_define_method(cache_stats_class, "[]", cache_stats_index, 1);
+
+  VALUE file_class = rb_const_get(rb_cObject, rb_intern("File"));
+  rb_define_singleton_method(file_class,
+                 "cache_stats",
+                 file_cache_stats,
+                 1);
+}

data/ext/cache_stats/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("cache_stats")

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: cache_stats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff McDonald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies: []
+description: View file cache residency info
+email:
+- jeff@jmickeyd.com
+executables: []
+extensions:
+- ext/cache_stats/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_stats.gemspec
+- examples/printcache.rb
+- ext/cache_stats/cache_stats.c
+- ext/cache_stats/extconf.rb
+homepage: https://github.com/jmickeyd/cache_stats
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: View file cache residency info
+test_files: []