fiemap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 707e3fc4c69e0f3cac4ab2a777cabd8e49fb6c7b
+  data.tar.gz: 5e4d497661e79e08265ddb13ddef89baac3da0e4
+SHA512:
+  metadata.gz: d251a7fd71d97821b17d2cd4f6816a351459df7b935b5e25f4e8d16f879578a3020dc0534178f8e504fcad88a5f8c6d7fc93e8bf64048cd36dd1384e616fe253
+  data.tar.gz: 698d3168ea96fa687218829cfab08bc60190cccb9fbbd66f6e8bf6baa6f32bc11d244cac5efed6fe71b85d97732fad15787e849aff5f8594c92b0a8d265986f9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fiemap.gemspec
+gemspec
+gem "rake-compiler"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Masaki Matsushita
+
+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,71 @@
+# Fiemap
+
+FIEMAP ioctl wrapper for Ruby.
+It adds File#extents and File::Extent class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fiemap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fiemap
+
+## Usage
+
+```ruby
+require "fiemap"
+
+f = File.open("something")
+extents = f.extents #=> [#<File::Extent logical:0 physical:0 flags:delalloc>, #<File::Extent logical:8192 physical:0 flags:last,delalloc>]
+
+extent = extents.last
+extent.last? #=> true
+extent.delalloc? #=> true
+extent.inline? #=> false
+
+extent.flags & File::Extent::FIEMAP_EXTENT_LAST #=> 1
+```
+
+## File::Extent
+
+### Instance Methods
+
+* last?
+* delalloc?
+* encoded?
+* encrypted?
+* not_aligned?
+* inline?
+* tail?
+* unwritten?
+* merged?
+
+### Constants
+
+* FIEMAP_EXTENT_LAST
+* FIEMAP_EXTENT_UNKNOWN
+* FIEMAP_EXTENT_DELALLOC
+* FIEMAP_EXTENT_ENCODED
+* FIEMAP_EXTENT_DATA_ENCRYPTED
+* FIEMAP_EXTENT_NOT_ALIGNED
+* FIEMAP_EXTENT_DATA_INLINE
+* FIEMAP_EXTENT_DATA_TAIL
+* FIEMAP_EXTENT_UNWRITTEN
+* FIEMAP_EXTENT_MERGED
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fiemap/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new "fiemap" do |ext|
+  ext.lib_dir = "lib/fiemap"
+end

data/ext/fiemap/extconf.rb

@@ -0,0 +1,2 @@
+require "mkmf"
+create_makefile("fiemap/fiemap")

data/ext/fiemap/fiemap.c

@@ -0,0 +1,233 @@
+#include <ruby.h>
+#include <ruby/io.h>
+#include <assert.h>
+#include <sys/ioctl.h>
+#include <linux/fs.h>
+#include <linux/fiemap.h>
+
+VALUE cExtent;
+static ID id_flush;
+
+enum {
+    MAX_EXTENT = 64
+};
+
+static size_t
+extent_memsize(const void *p)
+{
+    return p ? sizeof(struct fiemap_extent) : 0;
+}
+
+static const rb_data_type_t extent_data_type = {
+    "stat",
+    {NULL, RUBY_TYPED_DEFAULT_FREE, extent_memsize,},
+    NULL, NULL, RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE
+extent_new(VALUE klass, const struct fiemap_extent *extent)
+{
+    struct fiemap_extent *new_extent = NULL;
+
+    if (extent) {
+	new_extent = ALLOC(struct fiemap_extent);
+	*new_extent = *extent;
+    }
+    return TypedData_Wrap_Struct(klass, &extent_data_type, new_extent);
+}
+
+static VALUE
+extent_alloc(VALUE klass)
+{
+    return extent_new(klass, NULL);
+}
+
+static const struct fiemap_extent *
+get_extent(VALUE self)
+{
+    const struct fiemap_extent *extent;
+    TypedData_Get_Struct(self, struct fiemap_extent, &extent_data_type, extent);
+    return extent;
+}
+
+static VALUE
+extent_logical_offset(VALUE self)
+{
+    return LONG2NUM(get_extent(self)->fe_logical);
+}
+
+static VALUE
+extent_physical_offset(VALUE self)
+{
+    return LONG2NUM(get_extent(self)->fe_physical);
+}
+
+static VALUE
+extent_length(VALUE self)
+{
+    return LONG2NUM(get_extent(self)->fe_length);
+}
+
+static VALUE
+extent_flags(VALUE self)
+{
+    return INT2FIX(get_extent(self)->fe_flags);
+}
+
+static VALUE
+extent_test_flag(VALUE self, int flag)
+{
+    if (get_extent(self)->fe_flags & flag) {
+	return Qtrue;
+    }
+    return Qfalse;
+}
+
+static VALUE
+extent_last_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_LAST);
+}
+
+static VALUE
+extent_unknown_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_UNKNOWN);
+}
+
+static VALUE
+extent_delalloc_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_DELALLOC);
+}
+
+static VALUE
+extent_encoded_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_ENCODED);
+}
+
+static VALUE
+extent_encrypted_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_DATA_ENCRYPTED);
+}
+
+static VALUE
+extent_not_aligned_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_NOT_ALIGNED);
+}
+
+static VALUE
+extent_inline_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_DATA_INLINE);
+}
+
+static VALUE
+extent_tail_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_DATA_TAIL);
+}
+
+static VALUE
+extent_unwritten_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_UNWRITTEN);
+}
+
+static VALUE
+extent_merged_p(VALUE self)
+{
+    return extent_test_flag(self, FIEMAP_EXTENT_MERGED);
+}
+
+#define rb_sys_fail_path(path) rb_sys_fail(NIL_P(path) ? 0 : RSTRING_PTR(path))
+
+static VALUE
+rb_file_extents(VALUE io)
+{
+    unsigned int i;
+    VALUE temp;
+    rb_io_t *fptr;
+    __u64 end, start = 0;
+    struct stat statinfo;
+    VALUE extents = Qnil;
+    struct fiemap *p_filemap = (struct fiemap *)xmalloc(offsetof(struct fiemap, fm_extents[0]) + sizeof(struct fiemap_extent) * MAX_EXTENT);
+
+    temp = rb_io_check_io(io);
+    GetOpenFile(temp, fptr);
+
+    rb_funcall2(io, id_flush, 0, NULL);
+
+    if (fstat(fptr->fd, &statinfo) < 0) {
+	rb_sys_fail_path(fptr->pathv);
+    }
+
+    end = statinfo.st_size;
+    
+    while (start < end) {
+        p_filemap->fm_start  = start;
+        p_filemap->fm_length = end;
+        p_filemap->fm_flags = 0;
+        p_filemap->fm_extent_count = MAX_EXTENT;
+
+	if (ioctl(fptr->fd, FS_IOC_FIEMAP, p_filemap) == -1) {
+	    rb_sys_fail_path(fptr->pathv);
+	}
+
+	if (NIL_P(extents)) {
+	    extents = rb_ary_new_capa(p_filemap->fm_mapped_extents);
+	}
+	else {
+	    rb_ary_resize(extents, RARRAY_LEN(extents) + p_filemap->fm_mapped_extents);
+	}
+
+        for (i=0; i < p_filemap->fm_mapped_extents; i++) {
+            struct fiemap_extent extent;
+
+            extent = p_filemap->fm_extents[i];
+	    rb_ary_push(extents, extent_new(cExtent, &extent));
+            start = extent.fe_logical + extent.fe_length;
+        }
+    }
+
+    return extents;
+}
+
+void Init_fiemap(void) {
+    cExtent = rb_define_class_under(rb_cFile, "Extent", rb_cObject);
+    rb_define_alloc_func(cExtent, extent_alloc);
+
+    rb_define_method(cExtent, "offset", extent_logical_offset, 0);
+    rb_define_method(cExtent, "physical_offset", extent_physical_offset, 0);
+    rb_define_method(cExtent, "length", extent_length, 0);
+    rb_define_method(cExtent, "flags", extent_flags, 0);
+    rb_define_alias(cExtent, "size", "length");
+
+    rb_define_const(cExtent, "FIEMAP_EXTENT_LAST", INT2FIX(FIEMAP_EXTENT_LAST));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_UNKNOWN", INT2FIX(FIEMAP_EXTENT_UNKNOWN));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_DELALLOC", INT2FIX(FIEMAP_EXTENT_DELALLOC));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_ENCODED", INT2FIX(FIEMAP_EXTENT_ENCODED));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_DATA_ENCRYPTED", INT2FIX(FIEMAP_EXTENT_DATA_ENCRYPTED));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_NOT_ALIGNED", INT2FIX(FIEMAP_EXTENT_NOT_ALIGNED));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_DATA_INLINE", INT2FIX(FIEMAP_EXTENT_DATA_INLINE));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_DATA_TAIL", INT2FIX(FIEMAP_EXTENT_DATA_TAIL));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_UNWRITTEN", INT2FIX(FIEMAP_EXTENT_UNWRITTEN));
+    rb_define_const(cExtent, "FIEMAP_EXTENT_MERGED", INT2FIX(FIEMAP_EXTENT_MERGED));
+
+    rb_define_method(cExtent, "last?", extent_last_p, 0);
+    rb_define_method(cExtent, "delalloc?", extent_delalloc_p, 0);
+    rb_define_method(cExtent, "encoded?", extent_encoded_p, 0);
+    rb_define_method(cExtent, "encrypted?", extent_encrypted_p, 0);
+    rb_define_method(cExtent, "not_aligned?", extent_not_aligned_p, 0);
+    rb_define_method(cExtent, "inline?", extent_inline_p, 0);
+    rb_define_method(cExtent, "tail?", extent_tail_p, 0);
+    rb_define_method(cExtent, "unwritten?", extent_unwritten_p, 0);
+    rb_define_method(cExtent, "merged?", extent_merged_p, 0);
+
+    rb_define_method(rb_cFile, "extents", rb_file_extents, 0);
+
+    id_flush = rb_intern("flush");
+}

data/fiemap.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fiemap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fiemap"
+  spec.version       = FIEMAP::VERSION
+  spec.authors       = ["Masaki Matsushita"]
+  spec.email         = ["glass.saga@gmail.com"]
+  spec.summary       = %q{fiemap ioctl wrapper}
+  spec.description   = %q{fiemap ioctl wrapper}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.extensions    = %w[ext/fiemap/extconf.rb]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler", "~> 0.9.3"
+end

data/lib/fiemap/version.rb

@@ -0,0 +1,3 @@
+class FIEMAP
+  VERSION = "0.0.1"
+end

data/lib/fiemap.rb

@@ -0,0 +1,30 @@
+require "fiemap/version"
+require "fiemap/fiemap"
+
+class File
+  class Extent
+    private_class_method :new
+
+    def inspect
+      "#<#{self.class} logical:#{self.offset} physical:#{self.physical_offset} flags:#{flags_inspect}>"
+    end
+
+    alias to_s inspect
+
+    private
+
+    def flags_inspect
+      flags = []
+      flags << "last" if last?
+      flags << "delalloc" if delalloc?
+      flags << "encoded" if encoded?
+      flags << "encrypted" if encrypted?
+      flags << "not_aligned" if not_aligned?
+      flags << "inline?" if inline?
+      flags << "tail" if tail?
+      flags << "unwritten" if unwritten?
+      flags << "merged" if merged?
+      flags.join(",")
+    end
+  end
+end

data/spec/fiemap_spec.rb

@@ -0,0 +1,56 @@
+require_relative "spec_helper"
+
+describe "File#extents" do
+  context "one extent" do
+    let(:tempfile) { Tempfile.new("fiemap_spec") }
+
+    before { tempfile.write("a" * 4096) }
+
+    subject { tempfile.extents }
+
+    it { is_expected.to be_a Array }
+    it { expect(subject.size).to eq(1) }
+
+    after do
+      tempfile.close unless tempfile.closed?
+    end
+  end
+
+  context "two extent" do
+    let(:tempfile) { Tempfile.new("fiemap_spec") }
+
+    before do
+      tempfile.write("a" * 4096)
+      tempfile.seek(4096, :CUR)
+      tempfile.write("a" * 4096)
+    end
+
+    subject { tempfile.extents }
+
+    it { is_expected.to be_a Array }
+    it { expect(subject.size).to eq(2) }
+
+    after do
+      tempfile.close unless tempfile.closed?
+    end
+  end
+end
+
+describe File::Extent do
+  let(:tempfile) { Tempfile.new("fiemap_spec") }
+
+  before { tempfile.write("a" * 4096) }
+
+  subject { tempfile.extents.first }
+
+  flag_methods = [:last?, :delalloc?, :encoded?, :encrypted?, :not_aligned?, :inline?, :tail?, :unwritten?, :merged?]
+  flag_methods.each do |method|
+    it "#{method} doesn't raise error" do
+      expect { subject.send(method) }.not_to raise_error
+    end
+  end
+
+  after do
+    tempfile.close unless tempfile.closed?
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "tempfile"
+require_relative "../lib/fiemap"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: fiemap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masaki Matsushita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+description: fiemap ioctl wrapper
+email:
+- glass.saga@gmail.com
+executables: []
+extensions:
+- ext/fiemap/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/fiemap/extconf.rb
+- ext/fiemap/fiemap.c
+- fiemap.gemspec
+- lib/fiemap.rb
+- lib/fiemap/version.rb
+- spec/fiemap_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1
+signing_key: 
+specification_version: 4
+summary: fiemap ioctl wrapper
+test_files:
+- spec/fiemap_spec.rb
+- spec/spec_helper.rb
+has_rdoc: