ffi-libfuse 0.0.1.rctest12 → 0.3.3

data/sample/hello_fs.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ffi/libfuse'
+
+# Hello World!
+class HelloFS
+  include FFI::Libfuse::Adapter::Ruby
+  include FFI::Libfuse::Adapter::Fuse2Compat
+
+  # FUSE Configuration methods
+
+  def fuse_options(args)
+    args.parse!({ 'subject=' => :subject }) do |key:, value:, **|
+      raise FFI::Libfuse::Error, 'subject option must be at least 2 characters' unless value.size >= 2
+
+      @subject = value if key == :subject
+      :handled
+    end
+  end
+
+  def fuse_help
+    '-o subject=<subject>   a target to say hello to'
+  end
+
+  def fuse_configure
+    @subject ||= 'World!'
+    @content = "Hello #{@subject}\n"
+  end
+
+  # FUSE callbacks
+
+  def getattr(path, stat, *_args)
+    case path
+    when '/'
+      stat.directory(mode: 0o550)
+    when '/hello.txt'
+      stat.file(mode: 0o440, size: @content.size)
+    else
+      raise Errno::ENOENT
+    end
+  end
+
+  def readdir(_path, *_args)
+    yield 'hello.txt'
+  end
+
+  def read(_path, *_args)
+    @content
+  end
+end
+
+# Start the file system
+FFI::Libfuse.fuse_main(operations: HelloFS.new) if __FILE__ == $0

data/sample/memory_fs.rb

@@ -2,188 +2,12 @@
 # frozen_string_literal: true
 
 require 'ffi/libfuse'
+require 'ffi/libfuse/filesystem/virtual_fs'
 
 # A simple in-memory filesystem defined with hashes.
-#
-# It is writable to the user that mounted it may create and edit files within it
-#
-# === Usage
-#   root = Memory.new(files: { 'hello' => { 'world.txt' => 'Hello World'}})
-#   root.mkdir("/hello")
-#   root.("/hello/world","Hello World!\n")
-#   root.write("/hello/everybody","Hello Everyone!\n")
-#
-#   Libfuse::fuse_main($0,ARGV,operations: root)
-#
-#
-class MemoryFS
-  # @return [Hash<String,Object>] list of file objects by path
-  attr_reader :root
+class MemoryFS < FFI::Libfuse::Filesystem::VirtualFS; end
 
-  include FFI::Libfuse::Adapter::Fuse3Support
-  include FFI::Libfuse::Adapter::Ruby
-  include FFI::Libfuse::Adapter::Pathname
+# Set this to test multi-threading etc...
+main_class = ENV.fetch('MEMORY_FS_SKIP_DEFAULT_ARGS', 'N') == 'Y' ? FFI::Libfuse::Main : FFI::Libfuse
 
-  File = Struct.new(:mode, :content, :ctime, :atime, :mtime) do
-    def dig(*_args)
-      raise Errno::ENOTDIR
-    end
-
-    def fill_stat(stat = FFI::Stat.new)
-      stat.file(mode: mode, ctime: ctime, atime: atime, mtime: mtime, size: content.size)
-    end
-  end
-
-  # rubocop:disable Lint/StructNewOverride
-  Dir = Struct.new(:mode, :entries, :ctime, :atime, :mtime) do
-    def dig(*args)
-      entries.dig(*args)
-    end
-
-    def fill_stat(stat = FFI::Stat.new)
-      stat.directory(mode: mode, ctime: ctime, atime: atime, mtime: mtime)
-    end
-  end
-  # rubocop:enable Lint/StructNewOverride
-
-  def initialize(files: {}, max_size: 100_000, max_files: 1_000)
-    now = Time.now
-    @root = Dir.new(0x755, {}, now, now, now)
-    @total_size = 0
-    @total_files = 1
-    @max_size = max_size
-    @max_files = max_files
-
-    build(files)
-  end
-
-  def build(files, path = ::Pathname.new('/'))
-    files.each_pair do |basename, content|
-      raise 'Initial file keys must be String' unless basename.is_a?(String)
-      raise 'Initial file keys must not contain path separators' if basename =~ %r{[/\\]}
-
-      entry_path = path + basename
-      case content
-      when String
-        create(entry_path, 0x644)
-        write(entry_path, content, 0)
-      when Hash
-        mkdir(entry_path, 0x755)
-        build(content, entry_path)
-      else
-        raise 'Initial files must be String or Hash'
-      end
-    end
-  end
-
-  def fuse_version
-    'MemoryFS: Version x.y.z'
-  end
-
-  def fuse_traps
-    {
-      HUP: -> { reload }
-    }
-  end
-
-  def statfs(_path, statfs_buf)
-    blocks = @total_size / 1_000
-    statfs_buf.bsize    = 1 # block size (in Kb)
-    statfs_buf.frsize   = 1 # fragment size pretty much always bsize
-    statfs_buf.blocks   = @max_size
-    statfs_buf.bfree    = @max_size - blocks
-    statfs_buf.bavail   = @max_size - blocks
-    statfs_buf.files    = @max_files
-    statfs_buf.ffree    = @max_files - @total_files
-    statfs_buf.favail   = @max_files - @total_files
-    0
-  end
-
-  def getattr(path, stat_buf)
-    entry = find(path)
-    return -Errno::ENOENT::Errno unless entry
-
-    entry.fill_stat(stat_buf)
-    0
-  end
-
-  def readdir(path, _offset, _ffi)
-    %w[. ..].each { |d| yield(d, nil) }
-    dir = find(path)
-    dir.entries.each_pair { |k, e| yield(k, e.fill_stat) }
-  end
-
-  def create(path, mode, _ffi)
-    dir_entries = find(path.dirname).entries
-    now = Time.now
-    dir_entries[path.basename.to_s] = File.new(mode, String.new, now, now, now)
-    @total_files += 1
-    0
-  end
-
-  # op[:read] = [:pointer, :size_t, :off_t, FuseFileInfo.by_ref]
-  def read(path, len, off, _ffi)
-    file = find(path)
-    file.atime = Time.now.utc
-    FFI::Libfuse::ThreadPool.busy
-    sleep 0.5
-    file.content[off, len]
-  end
-
-  # write(const char* path, char *buf, size_t size, off_t offset, struct fuse_file_info* fi)
-  def write(path, data, offset, _ffi)
-    file = find(path)
-    content = file.content
-    @total_size -= content.size
-    content[offset, data.length] = data
-    @total_size += content.size
-    file.mtime = Time.now.utc
-  end
-
-  def truncate(path, size)
-    file = find(path)
-    @total_size -= file.content.size
-    file.content[size..-1] = ''
-    file.mtime = Time.now.utc
-    @total_size += file.content.size
-    0
-  end
-
-  def unlink(path)
-    dir = find(path.dirname)
-    deleted = dir.entries.delete(path.basename.to_s)
-    @total_files -= 1
-    @total_size -= deleted.content.size if deleted.is_a?(File)
-    0
-  end
-
-  def mkdir(path, mode)
-    entries = find(path.dirname).entries
-    now = Time.now
-    entries[path.basename.to_s] = Dir.new(mode, {}, now, now, now)
-  end
-
-  def rmdir(path)
-    dir = find(path)
-    raise Errno::ENOTDIR unless dir.is_a?(Dir)
-    raise Errno::ENOTEMPTY unless dir.entries.empty?
-
-    find(path.dirname).entries.delete(path.basename.to_s)
-    0
-  end
-
-  def utimens(path, atime, mtime)
-    entry = find(path)
-    entry.atime = atime if atime
-    entry.mtime = mtime if mtime
-    0
-  end
-
-  private
-
-  def find(path)
-    path.root? ? root : root.dig(*path.to_s.split('/')[1..])
-  end
-end
-
-exit(FFI::Libfuse.fuse_main($0, *ARGV, operations: MemoryFS.new)) if __FILE__ == $0
+exit(main_class.fuse_main(operations: MemoryFS.new)) if __FILE__ == $0

data/sample/no_fs.rb

@@ -6,13 +6,21 @@ require 'ffi/libfuse'
 # An empty file system
 class NoFS
   include FFI::Libfuse::Adapter::Context
-  include FFI::Libfuse::Adapter::Fuse3Support
   include FFI::Libfuse::Adapter::Ruby
+  include FFI::Libfuse::Adapter::Fuse3Support # must run outside of Adapter::Ruby
 
   OPTIONS = { 'log=' => :log }.freeze
 
-  def fuse_options
-    OPTIONS
+  def fuse_options(args)
+    args.parse!(OPTIONS) do |key:, value:, **|
+      case key
+      when :log
+        @logfile = value
+      else
+        next :keep
+      end
+      :handled
+    end
   end
 
   def fuse_help
@@ -24,46 +32,37 @@ class NoFS
   end
 
   def fuse_version
-    'NoFS: Version x.y.z'
-  end
-
-  def fuse_opt_proc(_data, arg, key, _outargs)
-    case key
-    when :log
-      @logfile = arg[4..]
-      return :handled
-    end
-    :keep
+    "NoFS: Version x.y.z. Fuse3Compat=#{fuse3_compat?}"
   end
 
-  def getattr(_ctx, path, stat)
+  def getattr(path, stat)
     raise Errno::ENOENT unless path == '/'
 
     stat.directory(mode: 0o555)
   end
 
-  def readdir(_ctx, _path, _offset, _ffi)
-    %w[. ..].each { |d| yield(d, nil) }
+  def readdir(_path, _offset, _ffi, &block)
+    puts "NOFS Readdir: #{block}"
+    %w[. ..].each(&block)
   end
 
   def log
     @log ||= File.open(@logfile || '/tmp/no_fs.out', 'a')
   end
 
-  def init(ctx, conn, cfg = nil)
+  def init(_conn)
+    ctx = FFI::Libfuse::Adapter::Context.fuse_context
     log.puts("NoFS init ctx- #{ctx.inspect}") if ctx
-    log.puts("NoFS init conn - #{conn.inspect}") if conn && !conn.null?
-    log.puts "NoFS init cfg #{cfg.inspect}" if cfg && !cfg.null?
     warn 'NoFS: DEBUG enabled' if debug?
     log.flush
     'INIT_DATA'
   end
 
-  def destroy(obj, *_rest)
+  def destroy(obj)
     # If the fs is not cleanly unmounted the init data will have been GC'd by the time this is called
     log.puts("NoFS destroy- #{obj.inspect}") if !obj.is_a?(WeakRef) || obj.weakref_alive?
     log.puts "NoFS destroy- pid=#{Process.pid}"
   end
 end
 
-exit(FFI::Libfuse.fuse_main($0, *ARGV, operations: NoFS.new, private_data: 'MAIN_DATA')) if __FILE__ == $0
+exit(FFI::Libfuse::Main.fuse_main($0, *ARGV, operations: NoFS.new, private_data: 'MAIN_DATA')) if __FILE__ == $0

data/sample/pass_through_fs.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ffi/libfuse'
+require 'ffi/libfuse/filesystem/pass_through_dir'
+
+# Pass Through Filesystem - over a base directory
+class PassThroughFS < FFI::Libfuse::Filesystem::PassThroughDir
+  def fuse_options(args)
+    args.parse!({ 'base_dir=' => :base_dir }) do |key:, value:, **|
+      next :keep unless key == :base_dir
+
+      raise FFI::Libfuse::Error, "#{value} is not a directory" unless Dir.exist?(value)
+
+      self.base_dir = value
+      :handled
+    end
+  end
+
+  def fuse_help
+    '-o base_dir=<dir>'
+  end
+
+  def fuse_configure
+    self.base_dir ||= Dir.pwd
+    warn "Using #{self.base_dir} as base directory for file operations" if debug?
+  end
+end
+
+exit(FFI::Libfuse.fuse_main(operations: PassThroughFS.new)) if __FILE__ == $0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-libfuse
 version: !ruby/object:Gem::Version
-  version: 0.0.1.rctest12
+  version: 0.3.3
 platform: ruby
 authors:
 - Grant Gardner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2023-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,6 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -74,9 +130,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- CHANGELOG.md
+- LICENSE
 - README.md
 - lib/ffi/accessors.rb
+- lib/ffi/boolean_int.rb
 - lib/ffi/devt.rb
+- lib/ffi/encoding.rb
 - lib/ffi/flock.rb
 - lib/ffi/gnu_extensions.rb
 - lib/ffi/libfuse.rb
@@ -90,8 +150,18 @@ files:
 - lib/ffi/libfuse/adapter/pathname.rb
 - lib/ffi/libfuse/adapter/ruby.rb
 - lib/ffi/libfuse/adapter/safe.rb
-- lib/ffi/libfuse/adapter/thread_local_context.rb
 - lib/ffi/libfuse/callbacks.rb
+- lib/ffi/libfuse/filesystem.rb
+- lib/ffi/libfuse/filesystem/accounting.rb
+- lib/ffi/libfuse/filesystem/mapped_dir.rb
+- lib/ffi/libfuse/filesystem/mapped_files.rb
+- lib/ffi/libfuse/filesystem/pass_through_dir.rb
+- lib/ffi/libfuse/filesystem/pass_through_file.rb
+- lib/ffi/libfuse/filesystem/utils.rb
+- lib/ffi/libfuse/filesystem/virtual_dir.rb
+- lib/ffi/libfuse/filesystem/virtual_file.rb
+- lib/ffi/libfuse/filesystem/virtual_fs.rb
+- lib/ffi/libfuse/filesystem/virtual_node.rb
 - lib/ffi/libfuse/fuse2.rb
 - lib/ffi/libfuse/fuse3.rb
 - lib/ffi/libfuse/fuse_args.rb
@@ -108,10 +178,10 @@ files:
 - lib/ffi/libfuse/fuse_opt.rb
 - lib/ffi/libfuse/fuse_poll_handle.rb
 - lib/ffi/libfuse/fuse_version.rb
+- lib/ffi/libfuse/gem_version.rb
 - lib/ffi/libfuse/job_pool.rb
 - lib/ffi/libfuse/main.rb
-- lib/ffi/libfuse/test.rb
-- lib/ffi/libfuse/test/operations.rb
+- lib/ffi/libfuse/test_helper.rb
 - lib/ffi/libfuse/thread_pool.rb
 - lib/ffi/libfuse/version.rb
 - lib/ffi/ruby_object.rb
@@ -122,13 +192,16 @@ files:
 - lib/ffi/stat_vfs.rb
 - lib/ffi/struct_array.rb
 - lib/ffi/struct_wrapper.rb
+- sample/hello_fs.rb
 - sample/memory_fs.rb
 - sample/no_fs.rb
+- sample/pass_through_fs.rb
 homepage: 
 licenses:
 - MIT
 metadata:
-  source_code_uri: http://github.com/lwoggardner/ffi-libfuse
+  source_code_uri: https://github.com/lwoggardner/ffi-libfuse
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -137,14 +210,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: FFI Bindings for Libfuse

data/lib/ffi/libfuse/adapter/thread_local_context.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../fuse_context'
-
-module FFI
-  module Libfuse
-    module Adapter
-      # Injects a wrapper via #{FuseCallbacks#fuse_wrappers} make the current {FuseContext} object available to
-      #  callbacks (except :destroy) via thread local variable :fuse_context
-      module ThreadLocalContext
-        # @!visibility private
-        def fuse_wrappers(*wrappers)
-          wrappers.unshift(
-            {
-              wrapper: proc { |_fm, *args, **_, &b| self.class.thread_local_context(*args, &b) },
-              excludes: %i[destroy]
-            }
-          )
-          return wrappers unless defined?(super)
-
-          super(*wrappers)
-        end
-
-        module_function
-
-        # Stores {FuseContext} in thread local variable :fuse_context before yielding
-        def thread_local_context(*args)
-          Thread.current[:fuse_context] = FuseContext.get
-          yield(*args)
-        ensure
-          Thread.current[:fuse_context] = nil
-        end
-      end
-    end
-  end
-end

data/lib/ffi/libfuse/test/operations.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../fuse_operations'
-
-module FFI
-  module Libfuse
-    module Test
-      # A FuseOperations that holds callback procs in a Hash rather than FFI objects and allows for direct invocation of
-      # callback methods
-      # @!parse FuseOperations
-      class Operations
-        include FuseCallbacks
-
-        def initialize(delegate:, fuse_wrappers: [])
-          @callbacks = {}
-          initialize_callbacks(delegate: delegate, wrappers: fuse_wrappers)
-        end
-
-        # @!visibility private
-        def [](member)
-          @callbacks[member]
-        end
-
-        # @!visibility private
-        def []=(member, value)
-          @callbacks[member] = value
-        end
-
-        # @!visibility private
-        def members
-          FuseOperations.members
-        end
-
-        private
-
-        # Allow the fuse operations to be called directly - useful for testing
-        # @todo some fancy wrapper to convert tests using Fuse2 signatures when Fuse3 is the loaded library
-        #   and vice-versa
-        def method_missing(method, *args)
-          callback = callback?(method) && self[method]
-          return super unless callback
-
-          callback.call(*args)
-        end
-
-        def respond_to_missing?(method, _private = false)
-          self[method] && callback?(method)
-        end
-
-        def callback?(method)
-          callback_members.include?(method)
-        end
-      end
-    end
-  end
-end

data/lib/ffi/libfuse/test.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test/operations'