fincore 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80ed7da7089920d4881cd9622d916ba0a88f9b9a
+  data.tar.gz: a9d324094e62d2ba0a00dcf6d7d097bca5c0b384
+SHA512:
+  metadata.gz: 8823ac5dd5518759131bd8a8003492bdbb49e45efd0f560985ba8960fb35881b46da42f3b26c9e57fd2d6f2c79d8acaeab44444f21421a48b313c84c2d032a9e
+  data.tar.gz: dad1442bfe0fa347ac001c5f71fc2e79d26cd5de64821ff43fc00ee7c2ba91e2c37afcde83ccadfe0883a0cabce04e21e3cb0a4285027b26f7a87a945ccc18e8

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+# ruby-fincore 
+Ruby File class extension to determine pages of file contents being resident in memory(in core).
+
+### Installation
+
+To install:
+
+```sh
+$ gem install fincore
+```
+
+### Usage
+
+```ruby
+require 'fincore'
+
+File.open('some/file') do |f|
+  f.cached_pages # return number of pages that are cached
+  f.total_pages  # return number of pages at total
+end
+```
+
+### Instance methods for File class
+* `cached_pages -> Integer`
+* `total_pages -> Integer`
+
+### Requirements
+Your platform must support mincore system call.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new 'fincore' do |ext|
+  ext.name = 'fincore'
+  ext.lib_dir = 'lib/fincore'
+end

data/ext/fincore/extconf.rb

@@ -0,0 +1,9 @@
+require 'mkmf'
+
+HEADERS = %w(unistd.h sys/mman.h sys/types.h sys/stat.h errno.h fcntl.h)
+
+HEADERS.each do |header|
+  have_header(header) || abort("#{header} is missing!")
+end
+
+create_makefile('fincore')

data/ext/fincore/fincore.c

@@ -0,0 +1,124 @@
+#include <unistd.h>
+#include <errno.h>
+#include <sys/mman.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <ruby.h>
+
+/*
+ * Document-method: total_pages
+ * call-seq:
+ *   total_pages -> Integer
+ * ==== Return
+ *   number of pages file allocated.
+ */
+VALUE rb_total_pages(VALUE self)
+{
+  int fd;
+  size_t page_size;
+  struct stat st;
+  VALUE rb_fd;
+  VALUE rb_error[2];
+
+  rb_fd = rb_funcall(self, rb_intern("fileno"), 0);
+  fd = NUM2INT(rb_fd);
+
+  // sysconf
+  page_size = sysconf(_SC_PAGESIZE);
+  if (-1 == page_size){
+    rb_error[0] = rb_str_new2("sysconf failed");
+    rb_error[1] = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(2, rb_error, rb_eSystemCallError));
+  }
+
+  // fstat
+  if (fstat(fd, &st)) {
+    rb_error[0] = rb_str_new2("fstat failed");
+    rb_error[1] = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(2, rb_error, rb_eSystemCallError));
+  }
+  return INT2NUM((st.st_size + page_size - 1) / page_size);
+}
+
+/*
+ * Document-method: cached_pages
+ * call-seq:
+ * pages that are cached
+ */
+VALUE rb_cached_pages(VALUE self)
+{
+  int fd;
+  size_t page_size, total_pages;
+  size_t index;
+  struct stat st;
+  void *mmap_p;
+  unsigned char *vec;
+  unsigned int cached_pages;
+
+  VALUE rb_fd;
+  VALUE rb_error[2];
+
+  rb_fd = rb_funcall(self, rb_intern("fileno"), 0);
+  fd = NUM2INT(rb_fd);
+
+
+  // sysconf
+  page_size = sysconf(_SC_PAGESIZE);
+  if (-1 == page_size){
+    rb_error[0] = rb_str_new2("sysconf failed");
+    rb_error[1] = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(2, rb_error, rb_eSystemCallError));
+  }
+
+
+  // fstat
+  if (fstat(fd, &st)) {
+    rb_error[0] = rb_str_new2("fstat failed");
+    rb_error[1] = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(2, rb_error, rb_eSystemCallError));
+  }
+
+  if (st.st_size == 0) return INT2FIX(0);
+
+  total_pages = (st.st_size + page_size - 1) / page_size;
+
+  // mmap
+  mmap_p = mmap(NULL, st.st_size, PROT_NONE, MAP_SHARED, fd, 0);
+
+  if (MAP_FAILED == mmap_p) {
+    rb_error[0] = rb_str_new2("mmap failed");
+    rb_error[1] = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(2, rb_error, rb_eSystemCallError));
+  }
+
+  vec = ALLOC_N(unsigned char, total_pages);
+
+  // mincore
+  if (mincore(mmap_p, st.st_size, vec)) {
+    xfree(vec);
+    rb_error[0] = rb_str_new2("mincore failed");
+    rb_error[1] = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(2, rb_error, rb_eSystemCallError));
+  }
+
+  // munmap
+  if (munmap(mmap_p, st.st_size)) {
+    xfree(vec);
+    rb_error[0] = rb_str_new2("munmap failed");
+    rb_error[1] = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(2, rb_error, rb_eSystemCallError));
+  }
+
+  cached_pages = 0;
+  for (index = 0; index < total_pages; ++index) {
+    if (vec[index] & 1) cached_pages++;
+  }
+  xfree(vec);
+  return INT2NUM(cached_pages);
+}
+
+void Init_fincore()
+{
+  rb_define_method(rb_cFile, "cached_pages", RUBY_METHOD_FUNC(rb_cached_pages), 0);
+  rb_define_method(rb_cFile, "total_pages", RUBY_METHOD_FUNC(rb_total_pages), 0);
+}

data/fincore.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'fincore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fincore'
+  spec.version       = Fincore::VERSION
+  spec.authors       = ['kzcat@outlook.jp']
+  spec.email         = ['kzcat@outlook.jp']
+  spec.summary       = %q{fincore}
+  spec.description   = %q{FIle class extention to determine pages of file contents being resident in memory(in core).}
+  spec.homepage      = 'https://github.com/kzcat/ruby-fincore'
+  spec.license       = 'MIT'
+  spec.extensions    = %w[ext/fincore/extconf.rb]
+  spec.files         = %w(ext/fincore/extconf.rb ext/fincore/fincore.c Rakefile fincore.gemspec Gemfile lib/fincore.rb lib/fincore/version.rb README.md)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/lib/fincore.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+
+require 'fincore/version'
+require 'fincore.so'

data/lib/fincore/version.rb

@@ -0,0 +1,3 @@
+module Fincore
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: fincore
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kzcat@outlook.jp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies: []
+description: FIle class extention to determine pages of file contents being resident
+  in memory(in core).
+email:
+- kzcat@outlook.jp
+executables: []
+extensions:
+- ext/fincore/extconf.rb
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- ext/fincore/extconf.rb
+- ext/fincore/fincore.c
+- fincore.gemspec
+- lib/fincore.rb
+- lib/fincore/version.rb
+homepage: https://github.com/kzcat/ruby-fincore
+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.4.6
+signing_key: 
+specification_version: 4
+summary: fincore
+test_files: []