qfs 0.0.13

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'simplecov', require: false, group: :test
+gem 'json', '1.8.3'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016 Quantcast, Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,56 @@
+# ruby-qfs
+
+Ruby bindings for [QFS](https://github.com/quantcast/qfs).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qfs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qfs
+
+## Usage
+
+The entrypoint to QFS with these bindings is the `Qfs::Client` object.  You can view the entire API in the documentation (TODO update this when open sourced) and see examples in "test/qfs_test.rb".
+
+## Testing
+
+You can run the tests on an existing instance of QFS.  By default, an local instance running on port 10000 is assumed, but you can specify a different location using environment variables.
+
+```shell
+rake test
+```
+
+By default, a stock QFS instance will likely have restricted permissions.  You may have to connect to QFS as root and manually chown/chmod the root to something that the user running the tests can access.
+
+#### Environment Variables for Tests
+* `QFS_TEST_PATH`: The directory in QFS to create and do all test-related operations in.
+* `QFS_TEST_HOST`: The host running QFS.
+* `QFS_TEST_PORT`: The port that QFS is running on.
+
+You can also enable debugging output by setting the environment variable `RUBY_QFS_TRACE`.
+
+```shell
+export RUBY_QFS_TRACE=1
+```
+
+## Caveats
+
+### `stat` can return stale data after modifications
+
+The behavior of the C API results in a `stat` call using stale data if modifications were made to a file since the connection was opened.  This can be avoided by opening and immediately closing the file that is being `stat`'ed.  You can enable this behavior by setting the `refresh` option to true:
+
+```ruby
+client.stat("/path/to/file", refresh: true)
+```
+
+Be aware that this may come with a performance penalty, so it may be better to use this option only when necessary.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+require 'rake/testtask'
+
+spec = Gem::Specification.load('qfs.gemspec')
+
+Rake::ExtensionTask.new do |ext|
+  ext.name = 'qfs_ext'
+  ext.gem_spec = spec
+  ext.ext_dir = 'ext/qfs'
+end
+
+desc 'Run the test suite against a local instance of QFS'
+Rake::TestTask.new test: :compile do |t|
+  t.pattern = 'test/*_test.rb'
+  t.libs << 'test'
+end
+
+task default: :test

data/ext/qfs/attr.c

@@ -0,0 +1,54 @@
+#include "attr.h"
+
+#include <ruby.h>
+#include "qfs.h"
+#include "util.h"
+
+VALUE cQfsAttr;
+
+#define QFS_ATTR_GET(f, t) static VALUE qfs_attr_##f(VALUE self) { \
+	struct qfs_attr *attr; \
+	Data_Get_Struct(self, struct qfs_attr, attr); \
+	return t(attr->f); \
+}
+
+QFS_ATTR_GET(filename, rb_str_new2)
+QFS_ATTR_GET(id, INT2FIX)
+QFS_ATTR_GET(mode, INT2FIX)
+QFS_ATTR_GET(uid, INT2FIX)
+QFS_ATTR_GET(gid, INT2FIX)
+QFS_ATTR_GET(mtime, NTIME)
+QFS_ATTR_GET(ctime, NTIME)
+QFS_ATTR_GET(directory, INT2BOOL)
+QFS_ATTR_GET(size, INT2FIX)
+QFS_ATTR_GET(chunks, INT2FIX)
+QFS_ATTR_GET(directories, INT2FIX)
+QFS_ATTR_GET(replicas, INT2FIX)
+QFS_ATTR_GET(stripes, INT2FIX)
+QFS_ATTR_GET(recovery_stripes, INT2FIX)
+QFS_ATTR_GET(striper_type, INT2FIX)
+QFS_ATTR_GET(stripe_size, INT2FIX)
+QFS_ATTR_GET(min_stier, INT2FIX)
+QFS_ATTR_GET(max_stier, INT2FIX)
+
+void init_qfs_ext_attr() {
+	cQfsAttr = rb_define_class_under(mQfs, "Attr", rb_cObject);
+	rb_define_method(cQfsAttr, "filename", qfs_attr_filename, 0);
+	rb_define_method(cQfsAttr, "id", qfs_attr_id, 0);
+	rb_define_method(cQfsAttr, "mode", qfs_attr_mode, 0);
+	rb_define_method(cQfsAttr, "uid", qfs_attr_uid, 0);
+	rb_define_method(cQfsAttr, "gid", qfs_attr_gid, 0);
+	rb_define_method(cQfsAttr, "mtime", qfs_attr_mtime, 0);
+	rb_define_method(cQfsAttr, "ctime", qfs_attr_ctime, 0);
+	rb_define_method(cQfsAttr, "directory?", qfs_attr_directory, 0);
+	rb_define_method(cQfsAttr, "size", qfs_attr_size, 0);
+	rb_define_method(cQfsAttr, "chunks", qfs_attr_chunks, 0);
+	rb_define_method(cQfsAttr, "directories", qfs_attr_directories, 0);
+	rb_define_method(cQfsAttr, "replicas", qfs_attr_replicas, 0);
+	rb_define_method(cQfsAttr, "stripes", qfs_attr_stripes, 0);
+	rb_define_method(cQfsAttr, "recovery_stripes", qfs_attr_recovery_stripes, 0);
+	rb_define_method(cQfsAttr, "striper_type", qfs_attr_striper_type, 0);
+	rb_define_method(cQfsAttr, "strip_size", qfs_attr_stripe_size, 0);
+	rb_define_method(cQfsAttr, "min_stier", qfs_attr_min_stier, 0);
+	rb_define_method(cQfsAttr, "max_stier", qfs_attr_max_stier, 0);
+}

data/ext/qfs/attr.h

@@ -0,0 +1,10 @@
+#ifndef QFS_EXT_ATTR_H_
+#define QFS_EXT_ATTR_H_
+
+#include <ruby.h>
+
+extern VALUE cQfsAttr;
+
+void init_qfs_ext_attr(void);
+
+#endif // QFS_EXT_ATTR_H_

data/ext/qfs/extconf.rb

@@ -0,0 +1,33 @@
+require 'mkmf'
+require 'rbconfig'
+
+INCLUDE_DIRS = [
+  RbConfig::CONFIG['includedir'],
+  '/usr/include',
+  '/usr/local/include',
+]
+
+LIB_DIRS = [
+  RbConfig::CONFIG['libdir'],
+  '/usr/lib',
+  '/usr/local/lib',
+]
+
+dir_config 'qfs', INCLUDE_DIRS, LIB_DIRS
+
+with_config('qfs-local-libs', '').split(':').each do |lib|
+  $LOCAL_LIBS << " #{lib} "
+end
+
+if with_config('version-script', '0') == '1'
+  $LDFLAGS << " -Wl,--version-script=#{File.expand_path('../qfs_ext.version', __FILE__)} "
+end
+
+abort '"kfs/c/qfs.h" is required' unless find_header 'kfs/c/qfs.h'
+abort 'libqfsc is required' unless find_library 'qfsc', 'qfs_open'
+
+$CFLAGS << ' -std=c99 -Wall -Wextra '
+
+$warnflags.gsub!('-Wdeclaration-after-statement', '') if $warnflags
+
+create_makefile 'qfs_ext'

data/ext/qfs/file.c

@@ -0,0 +1,133 @@
+#include "file.h"
+
+#include <ruby.h>
+#include "attr.h"
+#include "qfs.h"
+#include "util.h"
+
+VALUE cQfsFile;
+
+/* This is a handle to a fd that can perform IO. */
+static VALUE qfs_file_read(VALUE self, VALUE len) {
+	struct qfs_file *file;
+	struct qfs_client *client;
+	Check_Type(len, T_FIXNUM);
+	Data_Get_Struct(self, struct qfs_file, file);
+	Data_Get_Struct(file->client, struct qfs_client, client);
+	size_t n = (size_t)NUM2INT(len);
+	VALUE s = rb_str_buf_new((long)n);
+	ssize_t n_read = qfs_read(client->qfs, file->fd, RSTRING_PTR(s), n);
+	QFS_CHECK_ERR(n_read);
+	rb_str_set_len(s, n_read);
+	return s;
+}
+
+static VALUE qfs_file_tell(VALUE self) {
+	struct qfs_file *file;
+	struct qfs_client *client;
+	Data_Get_Struct(self, struct qfs_file, file);
+	Data_Get_Struct(file->client, struct qfs_client, client);
+	off_t offset = qfs_tell(client->qfs, file->fd);
+	QFS_CHECK_ERR(offset);
+	return INT2FIX(offset);
+}
+
+/* Returns a Qfs::Attr object for the file. */
+static VALUE qfs_file_stat(VALUE self) {
+	struct qfs_file *file;
+	struct qfs_client *client;
+	Data_Get_Struct(self, struct qfs_file, file);
+	Data_Get_Struct(file->client, struct qfs_client, client);
+	struct qfs_attr *attr = ALLOC(struct qfs_attr);
+	int res = qfs_stat_fd(client->qfs, file->fd, attr);
+	QFS_CHECK_ERR(res);
+	return Data_Wrap_Struct(cQfsAttr, NULL, free, attr);
+}
+
+static VALUE qfs_file_write(VALUE self, VALUE str) {
+	struct qfs_file *file;
+	struct qfs_client *client;
+	Check_Type(str, T_STRING);
+	Data_Get_Struct(self, struct qfs_file, file);
+	Data_Get_Struct(file->client, struct qfs_client, client);
+	ssize_t n = qfs_write(client->qfs, file->fd, RSTRING_PTR(str),
+			(size_t)RSTRING_LEN(str));
+	QFS_CHECK_ERR(n);
+	if (n < RSTRING_LEN(str)) {
+		WARN("partial write");
+	}
+	return INT2FIX(n);
+}
+
+static VALUE qfs_file_close(VALUE self) {
+	TRACE;
+	struct qfs_file *file;
+	struct qfs_client *client;
+	Data_Get_Struct(self, struct qfs_file, file);
+	Data_Get_Struct(file->client, struct qfs_client, client);
+	int err = qfs_close(client->qfs, file->fd);
+	QFS_CHECK_ERR(err);
+	file->fd = QFS_NIL_FD;
+	file->client = Qnil;
+	TRACE_R;
+	return Qnil;
+}
+
+static VALUE qfs_file_chmod(VALUE self, VALUE mode) {
+	struct qfs_file *file;
+	struct qfs_client *client;
+	Check_Type(mode, T_FIXNUM);
+	mode_t imode = (mode_t)FIX2INT(mode);
+	Data_Get_Struct(self, struct qfs_file, file);
+	Data_Get_Struct(file->client, struct qfs_client, client);
+	int res = qfs_chmod_fd(client->qfs, file->fd, imode);
+	QFS_CHECK_ERR(res);
+	return RES2BOOL(res);
+}
+
+static VALUE qfs_file_seek(VALUE self, VALUE offset, VALUE whence) {
+	struct qfs_file *file;
+	struct qfs_client *client;
+	Check_Type(offset, T_FIXNUM);
+	Check_Type(whence, T_FIXNUM);
+	off_t toffset = (off_t)FIX2INT(offset);
+	int iwhence = FIX2INT(whence);
+	Data_Get_Struct(self, struct qfs_file, file);
+	Data_Get_Struct(file->client, struct qfs_client, client);
+	off_t res = qfs_seek(client->qfs, file->fd, toffset, iwhence);
+	QFS_CHECK_ERR(res);
+	return INT2FIX((int)res);
+}
+
+void qfs_file_deallocate(void *filevp) {
+	TRACE;
+	/* the client might be deallocated already, so don't try to close ourselves */
+	free(filevp);
+	TRACE_R;
+}
+
+void qfs_file_mark(void *filevp) {
+	struct qfs_file *file = filevp;
+	if (file->client) {
+		rb_gc_mark(file->client);
+	}
+}
+
+VALUE qfs_file_allocate(VALUE klass) {
+	struct qfs_file *file = malloc(sizeof(struct qfs_file));
+	file->client = Qnil;
+	file->fd = QFS_NIL_FD;
+	return Data_Wrap_Struct(klass, qfs_file_mark, qfs_file_deallocate, file);
+}
+
+void init_qfs_ext_file() {
+	cQfsFile = rb_define_class_under(mQfs, "File", rb_cObject);
+	rb_define_alloc_func(cQfsFile, qfs_file_allocate);
+	rb_define_method(cQfsFile, "read_len", qfs_file_read, 1);
+	rb_define_method(cQfsFile, "tell", qfs_file_tell, 0);
+	rb_define_method(cQfsFile, "stat", qfs_file_stat, 0);
+	rb_define_method(cQfsFile, "write", qfs_file_write, 1);
+	rb_define_method(cQfsFile, "close", qfs_file_close, 0);
+	rb_define_method(cQfsFile, "chmod", qfs_file_chmod, 1);
+	rb_define_private_method(cQfsFile, "seek_internal", qfs_file_seek, 2);
+}