libgfapi-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c76e0c238e01dd72054a79ac78b55b71922d048
+  data.tar.gz: 418e0caf8e1a634b1485fce01a1770965a0922c6
+SHA512:
+  metadata.gz: b4ff79d6248fcc8eed086d14490da110e73c626b9e14134803c65416e6ce341bc13cdc2f5167d11e7077b34da3e2a1c755086832e80d9179ab86cadfcc227455
+  data.tar.gz: 9854d3d99c7e8af888f354f2b44097c6d78ba39004439dd709f4539d960a7be468cfe04d1e48e06017bdd8fa3667d4706a05fbd72b58cc16bd6ef4b7911b8895

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in libgfapi-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tomas Varaneckas
+
+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,40 @@
+# libgfapi-ruby
+
+Ruby bindings for [libgfapi](https://github.com/gluster/glusterfs/blob/master/api/src/glfs.h)
+(GlusterFS API).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'libgfapi-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install libgfapi-ruby
+
+## Usage
+
+```ruby
+require 'glusterfs'
+
+fs = GlusterFS.new 'my_volume'
+GlusterFS.set_volfile_server fs, 'tcp', '1.2.3.4', 24007
+GlusterFS.init fs
+fd = GlusterFS.creat fs, 'my_file', 2, 0755
+str = "test data\n"
+GlusterFS.write fd, str, str.size + 1, 0
+GlusterFS.close fd
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/spajus/libgfapi-ruby/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/glusterfs/version.rb

@@ -0,0 +1,3 @@
+module GlusterFS
+  VERSION = "0.0.1"
+end

data/lib/glusterfs.rb

@@ -0,0 +1,339 @@
+require "glusterfs/version"
+require "ffi"
+
+module GlusterFS
+  extend FFI::Library
+
+  # https://github.com/gluster/glusterfs/blob/master/api/src/glfs.h
+  ffi_lib 'gfapi'
+
+=begin
+  SYNOPSIS
+
+  glfs_new: Create a new 'virtual mount' object.
+
+  DESCRIPTION
+
+  This is most likely the very first function you will use. This function
+  will create a new glfs_t (virtual mount) object in memory.
+
+  On this newly created glfs_t, you need to be either set a volfile path
+  (glfs_set_volfile) or a volfile server (glfs_set_volfile_server).
+
+  The glfs_t object needs to be initialized with glfs_init() before you
+  can start issuing file operations on it.
+
+  PARAMETERS
+
+  @volname: Name of the volume. This identifies the server-side volume and
+            the fetched volfile (equivalent of --volfile-id command line
+      parameter to glusterfsd). When used with glfs_set_volfile() the
+      @volname has no effect (except for appearing in log messages).
+
+  RETURN VALUES
+
+  NULL   : Out of memory condition.
+  Others : Pointer to the newly created glfs_t virtual mount object.
+
+  glfs_t *glfs_new (const char *volname) __THROW;
+=end
+  attach_function :new, :glfs_new, [:string], :pointer
+
+=begin
+  SYNOPSIS
+
+  glfs_set_volfile: Specify the path to the volume specification file.
+
+  DESCRIPTION
+
+  If you are using a static volume specification file (without dynamic
+  volume management abilities from the CLI), then specify the path to
+  the volume specification file.
+
+  This is incompatible with glfs_set_volfile_server().
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be configured with the volume
+       specification file.
+
+  @volfile: Path to the locally available volume specification file.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_set_volfile (glfs_t *fs, const char *volfile);
+=end
+  attach_function :set_volfile, :gfs_set_volfile, [:pointer, :string], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_set_volfile_server: Specify the address of management server.
+
+  DESCRIPTION
+
+  This function specifies the address of the management server (glusterd)
+  to connect, and establish the volume configuration. The @volname
+  parameter passed to glfs_new() is the volume which will be virtually
+  mounted as the glfs_t object. All operations performed by the CLI at
+  the management server will automatically be reflected in the 'virtual
+  mount' object as it maintains a connection to glusterd and polls on
+  configuration change notifications.
+
+  This is incompatible with glfs_set_volfile().
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be configured with the volume
+       specification file.
+
+  @transport: String specifying the transport used to connect to the
+              management daemon. Specifying NULL will result in the usage
+        of the default (tcp) transport type. Permitted values
+        are those what you specify as transport-type in a volume
+        specification file (e.g "tcp", "rdma", "unix".)
+
+  @host: String specifying the address of where to find the management
+         daemon. Depending on the transport type this would either be
+   an FQDN (e.g: "storage01.company.com"), ASCII encoded IP
+   address "192.168.22.1", or a UNIX domain socket path (e.g
+   "/tmp/glusterd.socket".)
+
+  @port: The TCP port number where gluster management daemon is listening.
+         Specifying 0 uses the default port number GF_DEFAULT_BASE_PORT.
+   This parameter is unused if you are using a UNIX domain socket.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_set_volfile_server (glfs_t *fs, const char *transport,
+                               const char *host, int port) __THROW;
+=end
+  attach_function :set_volfile_server, :glfs_set_volfile_server,
+    [:pointer, :string, :string, :int], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_set_logging: Specify logging parameters.
+
+  DESCRIPTION
+
+  This function specifies logging parameters for the virtual mount.
+  Default log file is /dev/null.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be configured with the logging parameters.
+
+  @logfile: The logfile to be used for logging. Will be created if it does not
+            already exist (provided system permissions allow). If NULL, a new
+            logfile will be created in default log directory associated with
+            the glusterfs installation.
+
+  @loglevel: Numerical value specifying the degree of verbosity. Higher the
+             value, more verbose the logging.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_set_logging (glfs_t *fs, const char *logfile, int loglevel) __THROW;
+=end
+  attach_function :set_logging, :glfs_set_logging, [:pointer, :string, :int], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_init: Initialize the 'virtual mount'
+
+  DESCRIPTION
+
+  This function initializes the glfs_t object. This consists of many steps:
+  - Spawn a poll-loop thread.
+  - Establish connection to management daemon and receive volume specification.
+  - Construct translator graph and initialize graph.
+  - Wait for initialization (connecting to all bricks) to complete.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be initialized.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_init (glfs_t *fs) __THROW;
+=end
+  attach_function :init, :glfs_init, [:pointer], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_fini: Cleanup and destroy the 'virtual mount'
+
+  DESCRIPTION
+
+  This function attempts to gracefully destroy glfs_t object. An attempt is
+  made to wait for all background processing to complete before returning.
+
+  glfs_fini() must be called after all operations on glfs_t is finished.
+
+  IMPORTANT
+
+  IT IS NECESSARY TO CALL glfs_fini() ON ALL THE INITIALIZED glfs_t
+  OBJECTS BEFORE TERMINATING THE PROGRAM. THERE MAY BE CACHED AND
+  UNWRITTEN / INCOMPLETE OPERATIONS STILL IN PROGRESS EVEN THOUGH THE
+  API CALLS HAVE RETURNED. glfs_fini() WILL WAIT FOR BACKGROUND OPERATIONS
+  TO COMPLETE BEFORE RETURNING, THEREBY MAKING IT SAFE FOR THE PROGRAM TO
+  EXIT.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be destroyed.
+
+  RETURN VALUES
+
+   0 : Success.
+
+  int glfs_fini (glfs_t *fs) __THROW;
+=end
+  attach_function :fini, :glfs_fini, [:pointer], :int
+
+=begin
+  PER THREAD IDENTITY MODIFIERS
+
+  The following operations enable to set a per thread identity context
+  for the glfs APIs to perform operations as. The calls here are kept as close
+  to POSIX equivalents as possible.
+
+  NOTES:
+
+   - setgroups is a per thread setting, hence this is named as fsgroups to be
+     close in naming to the fs(u/g)id APIs
+   - Typical mode of operation is to set the IDs as required, with the
+     supplementary groups being optionally set, make the glfs call and post the
+     glfs operation set them back to eu/gid or uid/gid as appropriate to the
+     caller
+   - The groups once set, need to be unset by setting the size to 0 (in which
+     case the list argument is a do not care)
+   - Once a process for a thread of operation choses to set the IDs, all glfs
+     calls made from that thread would default to the IDs set for the thread.
+     As a result use these APIs with care and ensure that the set IDs are
+     reverted to global process defaults as required.
+
+  int glfs_setfsuid (uid_t fsuid) __THROW;
+  int glfs_setfsgid (gid_t fsgid) __THROW;
+  int glfs_setfsgroups (size_t size, const gid_t *list) __THROW;
+=end
+  attach_function :setfsuid, :glfs_setfsuid, [:int], :int
+  attach_function :setfsgid, :glfs_setfsgid, [:int], :int
+  attach_function :setfsgroups, :glfs_setfsgroups, [:uint, :pointer], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_open: Open a file.
+
+  DESCRIPTION
+
+  This function opens a file on a virtual mount.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be initialized.
+
+  @path: Path of the file within the virtual mount.
+
+  @flags: Open flags. See open(2). O_CREAT is not supported.
+          Use glfs_creat() for creating files.
+
+  RETURN VALUES
+
+  NULL   : Failure. @errno will be set with the type of failure.
+  Others : Pointer to the opened glfs_fd_t.
+
+  glfs_fd_t *glfs_open (glfs_t *fs, const char *path, int flags) __THROW;
+=end
+  attach_function :open, :glfs_open, [:pointer, :string, :int], :pointer
+
+=begin
+  SYNOPSIS
+
+  glfs_creat: Create a file.
+
+  DESCRIPTION
+
+  This function opens a file on a virtual mount.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be initialized.
+
+  @path: Path of the file within the virtual mount.
+
+  @mode: Permission of the file to be created.
+
+  @flags: Create flags. See open(2). O_EXCL is supported.
+
+  RETURN VALUES
+
+  NULL   : Failure. @errno will be set with the type of failure.
+  Others : Pointer to the opened glfs_fd_t.
+
+  glfs_fd_t *glfs_creat (glfs_t *fs, const char *path, int flags,
+           mode_t mode) __THROW;
+=end
+  attach_function :creat, :glfs_creat, [:pointer, :string, :int, :int], :pointer
+
+=begin
+  int glfs_close (glfs_fd_t *fd) __THROW;
+=end
+  attach_function :close, :glfs_close, [:pointer], :int
+
+=begin
+  // glfs_{read,write}[_async]
+
+  ssize_t glfs_read (glfs_fd_t *fd, void *buf,
+                     size_t count, int flags) __THROW;
+  ssize_t glfs_write (glfs_fd_t *fd, const void *buf,
+                      size_t count, int flags) __THROW;
+  int glfs_read_async (glfs_fd_t *fd, void *buf, size_t count, int flags,
+           glfs_io_cbk fn, void *data) __THROW;
+  int glfs_write_async (glfs_fd_t *fd, const void *buf, size_t count, int flags,
+            glfs_io_cbk fn, void *data) __THROW;
+=end
+  attach_function :read, :glfs_read, [:pointer, :string, :uint, :int], :uint
+  attach_function :write, :glfs_write, [:pointer, :string, :uint, :int], :uint
+  # TODO async
+
+=begin
+  int glfs_mkdir (glfs_t *fs, const char *path, mode_t mode) __THROW;
+=end
+  attach_function :mkdir, :glfs_mkdir, [:pointer, :string, :int], :int
+
+=begin
+  int glfs_unlink (glfs_t *fs, const char *path) __THROW;
+=end
+  attach_function :unlink, :glfs_unlink, [:pointer, :string], :int
+
+=begin
+  int glfs_rmdir (glfs_t *fs, const char *path) __THROW;
+=end
+  attach_function :rmdir, :glfs_rmdir, [:pointer, :string], :int
+
+=begin
+  int glfs_rename (glfs_t *fs, const char *oldpath, const char *newpath) __THROW;
+=end
+  attach_function :rename, :glfs_rename, [:pointer, :string, :string], :int
+
+  # TODO the rest
+
+end

data/libgfapi-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'glusterfs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "libgfapi-ruby"
+  spec.version       = GlusterFS::VERSION
+  spec.authors       = ["Tomas Varaneckas"]
+  spec.email         = ["tomas.varaneckas@gmail.com"]
+  spec.summary       = %q{Ruby bindings for libgfapi (GlusterFS API)}
+  spec.description   = %q{Ruby bindings for libgfapi (GlusterFS API)}
+  spec.homepage      = "https://github.com/spajus/libgfapi-ruby"
+  spec.license       = "MIT"
+
+  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_dependency "ffi", "~> 1.9"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: libgfapi-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Varaneckas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Ruby bindings for libgfapi (GlusterFS API)
+email:
+- tomas.varaneckas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/glusterfs.rb
+- lib/glusterfs/version.rb
+- libgfapi-ruby.gemspec
+homepage: https://github.com/spajus/libgfapi-ruby
+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.6
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for libgfapi (GlusterFS API)
+test_files: []
+has_rdoc: