couchbase 1.1.5 → 1.2.0.beta

data/ext/couchbase_ext/gethrtime.c

@@ -0,0 +1,124 @@
+/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2010, 2011 Couchbase, 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.
+ */
+
+#include "couchbase_ext.h"
+#include <stdlib.h>
+#include <time.h>
+#include <assert.h>
+
+#ifdef HAVE_MACH_MACH_TIME_H
+#include <mach/mach_time.h>
+#endif
+
+#ifdef HAVE_SYS_TIME_H
+#include <sys/time.h>
+#endif
+
+/*
+ * OS X doesn't have clock_gettime, but for monotonic, we can build
+ * one with mach_absolute_time as shown below.
+ *
+ * Most of the idea came from
+ * http://www.wand.net.nz/~smr26/wordpress/2009/01/19/monotonic-time-in-mac-os-x/
+ */
+
+#if defined(HAVE_MACH_ABSOLUTE_TIME) && !defined(HAVE_CLOCK_GETTIME)
+
+#define CLOCK_MONOTONIC 192996728
+
+static void mach_absolute_difference(uint64_t start, uint64_t end,
+                                     struct timespec *tp)
+{
+    uint64_t difference = end - start;
+    static mach_timebase_info_data_t info = {0, 0};
+
+    if (info.denom == 0) {
+        mach_timebase_info(&info);
+    }
+
+    uint64_t elapsednano = difference * (info.numer / info.denom);
+
+    tp->tv_sec = elapsednano * 1e-9;
+    tp->tv_nsec = elapsednano - (tp->tv_sec * 1e9);
+}
+
+static int clock_gettime(int which, struct timespec *tp)
+{
+    assert(which == CLOCK_MONOTONIC);
+
+    static uint64_t epoch = 0;
+
+    if (epoch == 0) {
+        epoch = mach_absolute_time();
+    }
+
+    uint64_t now = mach_absolute_time();
+
+    mach_absolute_difference(epoch, now, tp);
+
+    return 0;
+}
+
+#define HAVE_CLOCK_GETTIME 1
+#endif
+
+hrtime_t gethrtime(void)
+{
+#ifdef HAVE_CLOCK_GETTIME
+    struct timespec tm;
+    if (clock_gettime(CLOCK_MONOTONIC, &tm) == -1) {
+        abort();
+    }
+    return (((hrtime_t)tm.tv_sec) * 1000000000) + (hrtime_t)tm.tv_nsec;
+#elif HAVE_GETTIMEOFDAY
+
+    hrtime_t ret;
+    struct timeval tv;
+    if (gettimeofday(&tv, NULL) == -1) {
+        return (-1ULL);
+    }
+
+    ret = (hrtime_t)tv.tv_sec * 1000000000;
+    ret += tv.tv_usec * 1000;
+    return ret;
+#elif defined(HAVE_QUERYPERFORMANCECOUNTER)
+    double ret;
+    // To fix the potential race condition for the local static variable,
+    // gethrtime should be called in a global static variable first.
+    // It will guarantee the local static variable will be initialized
+    // before any thread calls the function.
+    static LARGE_INTEGER pf = { 0 };
+    static double freq;
+    LARGE_INTEGER currtime;
+
+    if (pf.QuadPart == 0) {
+        if (QueryPerformanceFrequency(&pf)) {
+            assert(pf.QuadPart != 0);
+            freq = 1.0e9 / (double)pf.QuadPart;
+        } else {
+            abort();
+        }
+    }
+
+    QueryPerformanceCounter(&currtime);
+
+    ret = (double)currtime.QuadPart * freq ;
+    return (hrtime_t)ret;
+#else
+#error "I don't know how to build a highres clock..."
+#endif
+}

data/ext/couchbase_ext/http.c

@@ -0,0 +1,402 @@
+/* vim: ft=c et ts=8 sts=4 sw=4 cino=
+ *
+ *   Copyright 2011, 2012 Couchbase, 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.
+ */
+
+#include "couchbase_ext.h"
+
+    void
+http_complete_callback(lcb_http_request_t request, lcb_t handle, const void *cookie, lcb_error_t error, const lcb_http_resp_t *resp)
+{
+    struct context_st *ctx = (struct context_st *)cookie;
+    struct bucket_st *bucket = ctx->bucket;
+    VALUE *rv = ctx->rv, key, val, res;
+
+    ctx->request->completed = 1;
+    key = STR_NEW((const char*)resp->v.v0.path, resp->v.v0.npath);
+    ctx->exception = cb_check_error_with_status(error,
+            "failed to execute HTTP request", key, resp->v.v0.status);
+    if (ctx->exception != Qnil) {
+        cb_gc_protect(bucket, ctx->exception);
+    }
+    val = resp->v.v0.nbytes ? STR_NEW((const char*)resp->v.v0.bytes, resp->v.v0.nbytes) : Qnil;
+    if (resp->v.v0.headers) {
+        cb_build_headers(ctx, resp->v.v0.headers);
+        cb_gc_unprotect(bucket, ctx->headers_val);
+    }
+    if (ctx->extended) {
+        res = rb_class_new_instance(0, NULL, cResult);
+        rb_ivar_set(res, id_iv_error, ctx->exception);
+        rb_ivar_set(res, id_iv_operation, sym_http_request);
+        rb_ivar_set(res, id_iv_key, key);
+        rb_ivar_set(res, id_iv_value, val);
+        rb_ivar_set(res, id_iv_completed, Qtrue);
+        rb_ivar_set(res, id_iv_headers, ctx->headers_val);
+    } else {
+        res = val;
+    }
+    if (ctx->proc != Qnil) {
+        cb_proc_call(ctx->proc, 1, res);
+    }
+    if (!bucket->async && ctx->exception == Qnil) {
+        *rv = res;
+    }
+    (void)handle;
+    (void)request;
+}
+
+    void
+http_data_callback(lcb_http_request_t request, lcb_t handle, const void *cookie, lcb_error_t error, const lcb_http_resp_t *resp)
+{
+    struct context_st *ctx = (struct context_st *)cookie;
+    struct bucket_st *bucket = ctx->bucket;
+    VALUE key, val, res;
+
+    key = STR_NEW((const char*)resp->v.v0.path, resp->v.v0.npath);
+    ctx->exception = cb_check_error_with_status(error,
+            "failed to execute HTTP request", key, resp->v.v0.status);
+    val = resp->v.v0.nbytes ? STR_NEW((const char*)resp->v.v0.bytes, resp->v.v0.nbytes) : Qnil;
+    if (ctx->exception != Qnil) {
+        cb_gc_protect(bucket, ctx->exception);
+        lcb_cancel_http_request(bucket->handle, request);
+    }
+    if (resp->v.v0.headers) {
+        cb_build_headers(ctx, resp->v.v0.headers);
+    }
+    if (ctx->proc != Qnil) {
+        if (ctx->extended) {
+            res = rb_class_new_instance(0, NULL, cResult);
+            rb_ivar_set(res, id_iv_error, ctx->exception);
+            rb_ivar_set(res, id_iv_operation, sym_http_request);
+            rb_ivar_set(res, id_iv_key, key);
+            rb_ivar_set(res, id_iv_value, val);
+            rb_ivar_set(res, id_iv_completed, Qfalse);
+            rb_ivar_set(res, id_iv_headers, ctx->headers_val);
+        } else {
+            res = val;
+        }
+        cb_proc_call(ctx->proc, 1, res);
+    }
+    (void)handle;
+}
+
+    void
+cb_http_request_free(void *ptr)
+{
+    struct http_request_st *request = ptr;
+    if (request) {
+        request->running = 0;
+        if (TYPE(request->bucket_obj) == T_DATA
+                && RDATA(request->bucket_obj)->dfree == (RUBY_DATA_FUNC)cb_bucket_free
+                && !request->completed) {
+            lcb_cancel_http_request(request->bucket->handle, request->request);
+        }
+        xfree((char *)request->cmd.v.v0.content_type);
+        xfree((char *)request->cmd.v.v0.path);
+        xfree((char *)request->cmd.v.v0.body);
+        xfree(request);
+    }
+}
+
+    void
+cb_http_request_mark(void *ptr)
+{
+    struct http_request_st *request = ptr;
+    if (request) {
+        rb_gc_mark(request->on_body_callback);
+    }
+}
+
+    VALUE
+cb_http_request_alloc(VALUE klass)
+{
+    VALUE obj;
+    struct http_request_st *request;
+
+    /* allocate new bucket struct and set it to zero */
+    obj = Data_Make_Struct(klass, struct http_request_st, cb_http_request_mark,
+            cb_http_request_free, request);
+    return obj;
+}
+
+/*
+ * Returns a string containing a human-readable representation of the
+ * CouchRequest.
+ *
+ * @since 1.2.0
+ *
+ * @return [String]
+ */
+    VALUE
+cb_http_request_inspect(VALUE self)
+{
+    VALUE str;
+    struct http_request_st *req = DATA_PTR(self);
+    char buf[200];
+
+    str = rb_str_buf_new2("#<");
+    rb_str_buf_cat2(str, rb_obj_classname(self));
+    snprintf(buf, 20, ":%p \"", (void *)self);
+    rb_str_buf_cat2(str, buf);
+    rb_str_buf_cat2(str, req->cmd.v.v0.path);
+    snprintf(buf, 100, "\" chunked:%s>", req->cmd.v.v0.chunked ? "true" : "false");
+    rb_str_buf_cat2(str, buf);
+
+    return str;
+}
+
+/*
+ * Initialize new CouchRequest
+ *
+ * @since 1.2.0
+ *
+ * @return [Bucket::CouchRequest]
+ */
+    VALUE
+cb_http_request_init(int argc, VALUE *argv, VALUE self)
+{
+    struct http_request_st *request = DATA_PTR(self);
+    VALUE bucket, path, opts, on_body, pp, arg;
+    rb_scan_args(argc, argv, "22", &bucket, &pp, &opts, &on_body);
+
+    if (NIL_P(on_body) && rb_block_given_p()) {
+        on_body = rb_block_proc();
+    }
+    if (CLASS_OF(bucket) != cBucket) {
+        rb_raise(rb_eTypeError, "wrong argument type (expected Couchbase::Bucket)");
+    }
+    memset(&request->cmd, 0, sizeof(lcb_http_cmd_t));
+    request->type = LCB_HTTP_TYPE_VIEW;
+    request->on_body_callback = on_body;
+    request->bucket = DATA_PTR(bucket);
+    request->bucket_obj = bucket;
+    request->extended = Qfalse;
+    path = StringValue(pp);	/* convert path to string */
+    request->cmd.v.v0.path = strdup(RSTRING_PTR(path));
+    request->cmd.v.v0.npath = RSTRING_LEN(path);
+    request->cmd.v.v0.method = LCB_HTTP_METHOD_GET;
+    request->cmd.v.v0.content_type = strdup("application/json");
+
+    if (opts != Qnil) {
+        Check_Type(opts, T_HASH);
+        request->extended = RTEST(rb_hash_aref(opts, sym_extended));
+        request->cmd.v.v0.chunked = RTEST(rb_hash_aref(opts, sym_chunked));
+        if ((arg = rb_hash_aref(opts, sym_type)) != Qnil) {
+            if (arg == sym_view) {
+                request->type = LCB_HTTP_TYPE_VIEW;
+            } else if (arg == sym_management) {
+                request->type = LCB_HTTP_TYPE_MANAGEMENT;
+            } else {
+                rb_raise(rb_eArgError, "unsupported request type");
+            }
+        }
+        if ((arg = rb_hash_aref(opts, sym_method)) != Qnil) {
+            if (arg == sym_get) {
+                request->cmd.v.v0.method = LCB_HTTP_METHOD_GET;
+            } else if (arg == sym_post) {
+                request->cmd.v.v0.method = LCB_HTTP_METHOD_POST;
+            } else if (arg == sym_put) {
+                request->cmd.v.v0.method = LCB_HTTP_METHOD_PUT;
+            } else if (arg == sym_delete) {
+                request->cmd.v.v0.method = LCB_HTTP_METHOD_DELETE;
+            } else {
+                rb_raise(rb_eArgError, "unsupported HTTP method");
+            }
+        }
+        if ((arg = rb_hash_aref(opts, sym_body)) != Qnil) {
+            Check_Type(arg, T_STRING);
+            request->cmd.v.v0.body = strdup(RSTRING_PTR(arg));
+            request->cmd.v.v0.nbody = RSTRING_LEN(arg);
+        }
+        if ((arg = rb_hash_aref(opts, sym_content_type)) != Qnil) {
+            Check_Type(arg, T_STRING);
+            xfree((char *)request->cmd.v.v0.content_type);
+            request->cmd.v.v0.content_type = strdup(RSTRING_PTR(arg));
+        }
+    }
+
+    return self;
+}
+
+/*
+ * Set +on_body+ callback
+ *
+ * @since 1.2.0
+ */
+    VALUE
+cb_http_request_on_body(VALUE self)
+{
+    struct http_request_st *request = DATA_PTR(self);
+    VALUE old = request->on_body_callback;
+    if (rb_block_given_p()) {
+        request->on_body_callback = rb_block_proc();
+    }
+    return old;
+}
+
+/*
+ * Execute {Bucket::CouchRequest}
+ *
+ * @since 1.2.0
+ */
+    VALUE
+cb_http_request_perform(VALUE self)
+{
+    struct http_request_st *req = DATA_PTR(self);
+    struct context_st *ctx;
+    VALUE rv, exc;
+    lcb_error_t err;
+    struct bucket_st *bucket;
+
+    ctx = xcalloc(1, sizeof(struct context_st));
+    if (ctx == NULL) {
+        rb_raise(eClientNoMemoryError, "failed to allocate memory");
+    }
+    rv = Qnil;
+    ctx->rv = &rv;
+    ctx->bucket = bucket = req->bucket;
+    ctx->proc = rb_block_given_p() ? rb_block_proc() : req->on_body_callback;
+    ctx->extended = req->extended;
+    ctx->request = req;
+    ctx->headers_val = cb_gc_protect(bucket, rb_hash_new());
+
+    err = lcb_make_http_request(bucket->handle, (const void *)ctx,
+            req->type, &req->cmd, &req->request);
+    exc = cb_check_error(err, "failed to schedule document request",
+            STR_NEW(req->cmd.v.v0.path, req->cmd.v.v0.npath));
+    if (exc != Qnil) {
+        xfree(ctx);
+        rb_exc_raise(exc);
+    }
+    req->running = 1;
+    req->ctx = ctx;
+    if (bucket->async) {
+        return Qnil;
+    } else {
+        lcb_wait(bucket->handle);
+        if (req->completed) {
+            exc = ctx->exception;
+            xfree(ctx);
+            if (exc != Qnil) {
+                cb_gc_unprotect(bucket, exc);
+                rb_exc_raise(exc);
+            }
+            return rv;
+        } else {
+            return Qnil;
+        }
+    }
+    return Qnil;
+}
+
+    VALUE
+cb_http_request_pause(VALUE self)
+{
+    struct http_request_st *req = DATA_PTR(self);
+    req->bucket->io->stop_event_loop(req->bucket->io);
+    return Qnil;
+}
+
+    VALUE
+cb_http_request_continue(VALUE self)
+{
+    VALUE exc, *rv;
+    struct http_request_st *req = DATA_PTR(self);
+
+    if (req->running) {
+        lcb_wait(req->bucket->handle);
+        if (req->completed) {
+            exc = req->ctx->exception;
+            rv = req->ctx->rv;
+            xfree(req->ctx);
+            if (exc != Qnil) {
+                cb_gc_unprotect(req->bucket, exc);
+                rb_exc_raise(exc);
+            }
+            return *rv;
+        }
+    } else {
+        cb_http_request_perform(self);
+    }
+    return Qnil;
+}
+
+/* Document-method: path
+ *
+ * @since 1.2.0
+ *
+ * @return [String] the requested path
+ */
+    VALUE
+cb_http_request_path_get(VALUE self)
+{
+    struct http_request_st *req = DATA_PTR(self);
+    return STR_NEW_CSTR(req->cmd.v.v0.path);
+}
+
+/* Document-method: chunked
+ *
+ * @since 1.2.0
+ *
+ * @return [Boolean] +false+ if library should collect whole response before
+ *   yielding, +true+ if the client is ready to handle response in chunks.
+ */
+    VALUE
+cb_http_request_chunked_get(VALUE self)
+{
+    struct http_request_st *req = DATA_PTR(self);
+    return req->cmd.v.v0.chunked ? Qtrue : Qfalse;
+}
+
+/* Document-method: extended
+ *
+ * @since 1.2.0
+ *
+ * @return [Boolean] if +false+ the callbacks should receive just the data,
+ *   and {Couchbase::Result} instance otherwise.
+ */
+    VALUE
+cb_http_request_extended_get(VALUE self)
+{
+    struct http_request_st *req = DATA_PTR(self);
+    return req->extended ? Qtrue : Qfalse;
+}
+
+/* Document-method: make_http_request(path, options = {})
+ *
+ * @since 1.2.0
+ *
+ * @param path [String]
+ * @param options [Hash]
+ * @option options [Boolean] :extended (false) set it to +true+ if the
+ *   {Couchbase::Result} object needed. The response chunk will be
+ *   accessible through +#value+ attribute.
+ * @yieldparam [String,Couchbase::Result] res the response chunk if the
+ *   :extended option is +false+ and result object otherwise
+ *
+ * @return [Couchbase::Bucket::CouchRequest]
+ */
+    VALUE
+cb_bucket_make_http_request(int argc, VALUE *argv, VALUE self)
+{
+    VALUE args[4]; /* bucket, path, options, block */
+
+    args[0] = self;
+    rb_scan_args(argc, argv, "11&", &args[1], &args[2], &args[3]);
+
+    return rb_class_new_instance(4, args, cCouchRequest);
+}
+
+