ruby-oci8 2.1.7 → 2.1.8

data/ChangeLog

@@ -1,3 +1,139 @@
+2015-04-04  Kubo Takehiro  <kubo@jiubao.org>
+	* NEWS: add changes between 2.1.7 and 2.1.8.
+	* VERSION: update to 2.1.8.
+	* dist-files: add new files.
+
+2015-04-04  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/extconf.rb, ext/oci8/oci8.h: Add a macro for old rubies which
+	    don't have rb_str_set_len().
+	* ext/oci8/hook_funcs.c: Suppress a warning.
+
+2015-04-04  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/lob.c: Increase the buffer size to read a LOB.
+
+2015-04-04  Kubo Takehiro  <kubo@jiubao.org>
+	* docs/install-instant-client.md, ext/oci8/lob.c, ext/oci8/metadata.c,
+	  ext/oci8/oci8.c: Update documents for YARD.
+
+2015-04-02  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/lob.c: Fix SEGV when a temporary LOB is freed by GC
+	    while reading another lob and the ruby version is 2.0.0 or
+	    upper.
+
+2015-03-01  Kubo Takehiro  <kubo@jiubao.org>
+	* lib/oci8/cursor.rb, lib/oci8/properties.rb:
+	    Fix errors while generating documents by yard such as
+	    "Exception occurred while generating 'OCI8/Cursor.html'."
+
+2015-03-01  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/oci8.c, ext/oci8/oci8.h: Rollback transactions on
+	    logoff only when the transactions are in progress.
+
+2015-01-27  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/ocihandle.c, ext/oci8/ocinumber.c, ext/oci8/oradate.c,
+	  ext/oci8/stmt.c: Suppreess warnings: "[warn]: @param tag has unknown parameter name: xxx"
+            by yard.
+
+2015-01-20  Kubo Takehiro  <kubo@jiubao.org>
+	* lib/oci8/oci8.rb: Add OCI8#send_timeout, OCI8#send_timeout=,
+	    OCI8#recv_timeout and OCI8#recv_timeout=.
+
+2015-01-20  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/hook_funcs.c, ext/oci8/oci8.c, ext/oci8/oci8.h:
+	    Fix for cancel_read_at_exit on Windows.
+
+2015-01-20  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/oci8.c, ext/oci8/oci8lib.c, lib/oci8/properties.rb:
+	    Add OCI8.properties[:cancel_read_at_exit].
+
+2015-01-20  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/extconf.rb, ext/oci8/hook_funcs.c, ext/oci8/oci8.c,
+	  ext/oci8/oci8.h, ext/oci8/oci8lib.c, ext/oci8/plthook.h,
+	  ext/oci8/plthook_elf.c, ext/oci8/plthook_osx.c,
+	  ext/oci8/plthook_win32.c: Cancel read system calls at exit
+	    not to block ruby process termination.
+	    This works on Linux, OSX and Windows Vista or upper.
+	    (github issue #56)
+
+2015-01-12  Kubo Takehiro  <kubo@jiubao.org>
+	* README.md: Fix a broken link.
+	    (github issue #67 reported by Zloy)
+
+2014-12-30  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/lob.c, ext/oci8/oci8lib.c: Revise type checking of LOB.
+
+2014-12-30  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/bind.c, ext/oci8/connection_pool.c, ext/oci8/lob.c,
+	  ext/oci8/metadata.c, ext/oci8/object.c, ext/oci8/oci8.c, ext/oci8/oci8.h,
+	  ext/oci8/oci8lib.c, ext/oci8/ocihandle.c, ext/oci8/stmt.c:
+	    Add oci8_check_typeddata() and use it instead of oci8_get_handle()
+	    and oci8_get_bind().
+
+2014-12-30  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/oradate.c: Add check_oradate() to check datatype.
+
+2014-12-30  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/lob.c, ext/oci8/metadata.c, ext/oci8/object.c, ext/oci8/stmt.c:
+	    Add more write barriers.
+
+2014-12-29  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/bind.c, ext/oci8/connection_pool.c, ext/oci8/lob.c,
+	  ext/oci8/metadata.c, ext/oci8/object.c, ext/oci8/oci8.c, ext/oci8/oci8.h
+	  ext/oci8/oci8lib.c, ext/oci8/ocidatetime.c, ext/oci8/ocihandle.c,
+	  ext/oci8/ocinumber.c, ext/oci8/oradate.c, ext/oci8/stmt.c:
+	    Use rb_data_type_t as the base type of oci8_handle_data_type_t.
+
+2014-12-29  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/bind.c, ext/oci8/connection_pool.c, ext/oci8/lob.c,
+	  ext/oci8/metadata.c, ext/oci8/object.c, ext/oci8/oci8.c, ext/oci8/oci8.h
+	  ext/oci8/oci8lib.c, ext/oci8/ocidatetime.c, ext/oci8/ocihandle.c,
+	  ext/oci8/ocinumber.c, ext/oci8/oradate.c, ext/oci8/stmt.c:
+	    Rename vtable and vptr to data_type.
+
+2014-12-29  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/bind.c, ext/oci8/connection_pool.c, ext/oci8/lob.c,
+	  ext/oci8/metadata.c, ext/oci8/object.c, ext/oci8/oci8.c, ext/oci8/oci8.h
+	  ext/oci8/oci8lib.c, ext/oci8/ocidatetime.c, ext/oci8/ocihandle.c,
+	  ext/oci8/ocinumber.c, ext/oci8/oradate.c, ext/oci8/stmt.c:
+	    Add oci8_allocate_typeddata() and use it to allocate OCI objects.
+
+2014-12-23  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/connection_pool.c, ext/oci8/metadata.c, ext/oci8/object.c,
+	  ext/oci8/oci8.c, ext/oci8/oci8.h, ext/oci8/oci8lib.c, ext/oci8/ocihandle.c
+	  ext/oci8/ocinumber.c, ext/oci8/oradate.c, ext/oci8/stmt.c:
+	    Add write barriers to use generational GC.
+
+2014-12-23  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/oci8.h, ext/oci8/oci8lib.c, ext/oci8/ocihandle.c,
+	  ext/oci8/ocinumber.c, ext/oci8/oradate.c:
+	    Use TypedData on ruby 1.9.3 and later.
+
+2014-12-22  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/extconf.rb, ext/oci8/stmt.c: Don't use SYM2ID on ruby 2.2.0
+	    or later. Symbols passed to SYM2ID are not GC'ed.
+
+2014-12-21  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/bind.c, ext/oci8/object.c, ext/oci8/oci8.h, ext/oci8/oci8lib.c,
+	  ext/oci8/ocidatetime.c, ext/oci8/ocihandle.c, ext/oci8/ocinumber.c:
+	    Use RARRAY_AREF and RARRAY_CONST_PTR for Generational GC.
+
+2014-12-06  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/connection_pool.c, ext/oci8/lob.c, ext/oci8/oci8.c,
+	  ext/oci8/stmt.c: Fix "RuntimeError:executing in another thread"
+	    when a closed connection is used. This bug was introduced by
+	    the previous commit.
+	    (github issue #64 reported by Yasuo Honda)
+
+2014-11-16  Kubo Takehiro  <kubo@jiubao.org>
+	* ext/oci8/attr.c, ext/oci8/bind.c, ext/oci8/connection_pool.c,
+	  ext/oci8/lob.c, ext/oci8/metadata.c, ext/oci8/object.c,
+	  ext/oci8/oci8.c, ext/oci8/oci8.h, ext/oci8/oci8lib.c,
+	  ext/oci8/ocihandle.c, ext/oci8/stmt.c:
+	    Raises an exception when a closed OCI8 object is used.
+	    Using a closed cursor causes various problems such as segmentation
+	    fault, nil comparison error and so on.
+	    (github issue #61 and #62 reported by Mike Bourgeous)
+
 2014-02-02  Kubo Takehiro  <kubo@jiubao.org>
 	* NEWS: add changes between 2.1.7 and 2.1.6.
 	* VERSION: change the version to 2.1.7.

data/NEWS

@@ -1,5 +1,66 @@
 # @markup markdown
 
+2.1.8
+=====
+
+New Features
+------------
+
+### Send and receive timeouts
+
+New methods {OCI8#send_timeout}, {OCI8#send_timeout=}, {OCI8#recv_timeout} and {OCI8#recv_timeout=}
+were added. They are available on Oracle 11.1 or upper.
+
+Use them at your own risk because they use [undocumented OCI handle attributes](http://blog.jiubao.org/2015/01/undocumented-oci-handle-attributes.html).
+
+### Cancel read system calls not to prevent ruby process termination
+
+When network quality is poor and incoming packets are lost irregularly,
+the ruby process termination may be blocked until TCP keepalive time (2 hours).
+
+By setting [OCI8.properties[:cancel_read_at_exit]](OCI8.html#properties-class_method)
+true, read system calls, which may wait incoming packets, are canceled at exit.
+See: [github issue #56](https://github.com/kubo/ruby-oci8/issues/56)
+
+This feature is disabled by default because it uses [unusual technique](https://github.com/kubo/plthook)
+which hooks read system calls issued by Oracle client library and it works only on
+Linux, Windows and OSX.
+
+### RGenGC
+
+Object allocation code is rewritten to use [RGenGC](http://www.infoq.com/news/2013/12/ruby21).
+
+Fixed Issues
+------------
+
+-   Raises an exception when a closed OCI8 object is used.
+    Using a closed cursor causes various problems such as segmentation
+    fault, nil comparison error and so on.
+    See: [github issue #61](https://github.com/kubo/ruby-oci8/issues/61)
+    and [github issue #62](https://github.com/kubo/ruby-oci8/issues/62)
+
+    (reported by Mike Bourgeous)
+
+-   Fix "RuntimeError:executing in another thread"
+    when a closed connection is used. This bug was introduced by
+    the previously listed issue.
+    See: [github issue #64](https://github.com/kubo/ruby-oci8/issues/64)
+
+    (reported by Yasuo Honda)
+
+-   Fix SEGV when a temporary LOB is freed by GC while reading another
+    lob and the ruby version is 2.0.0 or upper.
+
+-   Skip rollback on logoff when no transactions are in progress.
+
+-   Fix a broken link in README.md.
+    See: [github issue #67](https://github.com/kubo/ruby-oci8/issues/67)
+
+    (reported by Zloy)
+
+-   Don't use SYM2ID on ruby 2.2.0 or later not to make symbols unGCable
+    by [Symbol GC](http://www.infoq.com/news/2014/12/ruby-2.2.0-released).
+
 2.1.7
 =====
 

data/README.md

@@ -21,10 +21,10 @@ Connect to scott/tiger, select `emp` and print as CSV format.
 
 If you install a ruby-oci8 gem package, you may need to add `-rubygems` before `-r oci8`.
 
-API Reference
+Documentation
 =============
 
-* http://rubydoc.info/gems/ruby-oci8/frames/file/README.md
+* http://rubydoc.info/gems/ruby-oci8/
 
 Installation
 ============

data/VERSION

@@ -1 +1 @@
-2.1.7
+2.1.8

data/dist-files

@@ -29,6 +29,7 @@ ext/oci8/encoding.c
 ext/oci8/env.c
 ext/oci8/error.c
 ext/oci8/extconf.rb
+ext/oci8/hook_funcs.c
 ext/oci8/lob.c
 ext/oci8/metadata.c
 ext/oci8/object.c
@@ -42,6 +43,10 @@ ext/oci8/oraconf.rb
 ext/oci8/oradate.c
 ext/oci8/oranumber_util.c
 ext/oci8/oranumber_util.h
+ext/oci8/plthook.h
+ext/oci8/plthook_elf.c
+ext/oci8/plthook_osx.c
+ext/oci8/plthook_win32.c
 ext/oci8/post-config.rb
 ext/oci8/stmt.c
 ext/oci8/thread_util.c

data/docs/install-instant-client.md

@@ -45,6 +45,8 @@ Note:
 * use libclntsh.sl instead of libclntsh.so on HP-UX PA-RISC.
 * use libclntsh.dylib instead of libclntsh.so on Mac OS X.
 * skip this step for AIX.
+* run `yum install libaio` also on Redhat.
+* run `apt-get install libaio1` also on Ubuntu.
 
 Set the library search path, whose name depends on the OS, to point to
 the installed directory.

data/ext/oci8/attr.c

@@ -6,15 +6,6 @@
  */
 #include "oci8.h"
 
-VALUE oci8_get_ub2_attr(oci8_base_t *base, ub4 attrtype, OCIStmt *stmtp)
-{
-    ub2 val;
-
-    chker3(OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp),
-           base, stmtp);
-    return INT2FIX(val);
-}
-
 #define MAX_ROWID_LEN 128
 
 typedef struct {

data/ext/oci8/bind.c

@@ -2,7 +2,7 @@
 /*
  * bind.c
  *
- * Copyright (C) 2002-2011 KUBO Takehiro <kubo@jiubao.org>
+ * Copyright (C) 2002-2014 Kubo Takehiro <kubo@jiubao.org>
  */
 #include "oci8.h"
 
@@ -25,6 +25,23 @@ typedef struct {
     ub1 csfrm;
 } oci8_bind_string_t;
 
+const oci8_handle_data_type_t oci8_bind_data_type = {
+    {
+        "OCI8::BindType::Base",
+        {
+            NULL,
+            oci8_handle_cleanup,
+            oci8_handle_size,
+        },
+        &oci8_handle_data_type.rb_data_type, NULL,
+#ifdef RUBY_TYPED_WB_PROTECTED
+        RUBY_TYPED_WB_PROTECTED,
+#endif
+    },
+    NULL,
+    0,
+};
+
 /*
  * bind_string
  */
@@ -104,9 +121,20 @@ static void bind_string_post_bind_hook(oci8_bind_t *obind)
            &obind->base);
 }
 
-static const oci8_bind_vtable_t bind_string_vtable = {
+static const oci8_bind_data_type_t bind_string_data_type = {
     {
-        NULL,
+        {
+            "OCI8::BindType::String",
+            {
+                NULL,
+                oci8_handle_cleanup,
+                oci8_handle_size,
+            },
+            &oci8_bind_data_type.rb_data_type, NULL,
+#ifdef RUBY_TYPED_WB_PROTECTED
+            RUBY_TYPED_WB_PROTECTED,
+#endif
+        },
         oci8_bind_free,
         sizeof(oci8_bind_string_t)
     },
@@ -119,6 +147,11 @@ static const oci8_bind_vtable_t bind_string_vtable = {
     bind_string_post_bind_hook,
 };
 
+static VALUE bind_string_alloc(VALUE klass)
+{
+    return oci8_allocate_typeddata(klass, &bind_string_data_type.base);
+}
+
 /*
  * bind_raw
  */
@@ -141,9 +174,20 @@ static void bind_raw_set(oci8_bind_t *obind, void *data, void **null_structp, VA
     vstr->size = RSTRING_LEN(val);
 }
 
-static const oci8_bind_vtable_t bind_raw_vtable = {
+static const oci8_bind_data_type_t bind_raw_data_type = {
     {
-        NULL,
+        {
+            "OCI8::BindType::RAW",
+            {
+                NULL,
+                oci8_handle_cleanup,
+                oci8_handle_size,
+            },
+            &oci8_bind_data_type.rb_data_type, NULL,
+#ifdef RUBY_TYPED_WB_PROTECTED
+            RUBY_TYPED_WB_PROTECTED,
+#endif
+        },
         oci8_bind_free,
         sizeof(oci8_bind_string_t)
     },
@@ -155,6 +199,11 @@ static const oci8_bind_vtable_t bind_raw_vtable = {
     SQLT_LVB
 };
 
+static VALUE bind_raw_alloc(VALUE klass)
+{
+    return oci8_allocate_typeddata(klass, &bind_raw_data_type.base);
+}
+
 /*
  * bind_binary_double
  */
@@ -178,9 +227,20 @@ static void bind_binary_double_init(oci8_bind_t *obind, VALUE svc, VALUE val, VA
 #ifndef SQLT_BDOUBLE
 #define SQLT_BDOUBLE 22
 #endif
-static const oci8_bind_vtable_t bind_binary_double_vtable = {
+static const oci8_bind_data_type_t bind_binary_double_data_type = {
     {
-        NULL,
+        {
+            "OCI8::BindType::BinaryDouble",
+            {
+                NULL,
+                oci8_handle_cleanup,
+                oci8_handle_size,
+            },
+            &oci8_bind_data_type.rb_data_type, NULL,
+#ifdef RUBY_TYPED_WB_PROTECTED
+            RUBY_TYPED_WB_PROTECTED,
+#endif
+        },
         oci8_bind_free,
         sizeof(oci8_bind_t)
     },
@@ -192,10 +252,15 @@ static const oci8_bind_vtable_t bind_binary_double_vtable = {
     SQLT_BDOUBLE
 };
 
+static VALUE bind_binary_double_alloc(VALUE klass)
+{
+    return oci8_allocate_typeddata(klass, &bind_binary_double_data_type.base);
+}
+
 static VALUE oci8_bind_get(VALUE self)
 {
-    oci8_bind_t *obind = DATA_PTR(self);
-    const oci8_bind_vtable_t *vptr = (const oci8_bind_vtable_t *)obind->base.vptr;
+    oci8_bind_t *obind = TO_BIND(self);
+    const oci8_bind_data_type_t *data_type = (const oci8_bind_data_type_t *)obind->base.data_type;
     ub4 idx = obind->curar_idx;
     void **null_structp = NULL;
 
@@ -203,12 +268,12 @@ static VALUE oci8_bind_get(VALUE self)
         if (obind->u.inds[idx] != 0)
             return Qnil;
     }
-    return vptr->get(obind, (void*)((size_t)obind->valuep + obind->alloc_sz * idx), null_structp);
+    return data_type->get(obind, (void*)((size_t)obind->valuep + obind->alloc_sz * idx), null_structp);
 }
 
 static VALUE oci8_bind_get_data(VALUE self)
 {
-    oci8_bind_t *obind = DATA_PTR(self);
+    oci8_bind_t *obind = TO_BIND(self);
 
     if (obind->maxar_sz == 0) {
         obind->curar_idx = 0;
@@ -227,8 +292,8 @@ static VALUE oci8_bind_get_data(VALUE self)
 
 static VALUE oci8_bind_set(VALUE self, VALUE val)
 {
-    oci8_bind_t *obind = DATA_PTR(self);
-    const oci8_bind_vtable_t *vptr = (const oci8_bind_vtable_t *)obind->base.vptr;
+    oci8_bind_t *obind = TO_BIND(self);
+    const oci8_bind_data_type_t *data_type = (const oci8_bind_data_type_t *)obind->base.data_type;
     ub4 idx = obind->curar_idx;
 
     if (NIL_P(val)) {
@@ -247,14 +312,14 @@ static VALUE oci8_bind_set(VALUE self, VALUE val)
             null_structp = &obind->u.null_structs[idx];
             *(OCIInd*)obind->u.null_structs[idx] = 0;
         }
-        vptr->set(obind, (void*)((size_t)obind->valuep + obind->alloc_sz * idx), null_structp, val);
+        data_type->set(obind, (void*)((size_t)obind->valuep + obind->alloc_sz * idx), null_structp, val);
     }
     return self;
 }
 
 static VALUE oci8_bind_set_data(VALUE self, VALUE val)
 {
-    oci8_bind_t *obind = DATA_PTR(self);
+    oci8_bind_t *obind = TO_BIND(self);
 
     if (obind->maxar_sz == 0) {
         obind->curar_idx = 0;
@@ -270,7 +335,7 @@ static VALUE oci8_bind_set_data(VALUE self, VALUE val)
         }
         for (idx = 0; idx < size; idx++) {
             obind->curar_idx = idx;
-            rb_funcall(self, oci8_id_set, 1, RARRAY_PTR(val)[idx]);
+            rb_funcall(self, oci8_id_set, 1, RARRAY_AREF(val, idx));
         }
         obind->curar_sz = size;
     }
@@ -279,8 +344,8 @@ static VALUE oci8_bind_set_data(VALUE self, VALUE val)
 
 static VALUE oci8_bind_initialize(VALUE self, VALUE svc, VALUE val, VALUE length, VALUE max_array_size)
 {
-    oci8_bind_t *obind = DATA_PTR(self);
-    const oci8_bind_vtable_t *bind_class = (const oci8_bind_vtable_t *)obind->base.vptr;
+    oci8_bind_t *obind = TO_BIND(self);
+    const oci8_bind_data_type_t *bind_class = (const oci8_bind_data_type_t *)obind->base.data_type;
     ub4 cnt = 1;
 
     obind->tdo = Qnil;
@@ -354,16 +419,9 @@ void Init_oci8_bind(VALUE klass)
     rb_define_private_method(cOCI8BindTypeBase, "set_data", oci8_bind_set_data, 1);
 
     /* register primitive data types. */
-    oci8_define_bind_class("String", &bind_string_vtable);
-    oci8_define_bind_class("RAW", &bind_raw_vtable);
+    oci8_define_bind_class("String", &bind_string_data_type, bind_string_alloc);
+    oci8_define_bind_class("RAW", &bind_raw_data_type, bind_raw_alloc);
     if (oracle_client_version >= ORAVER_10_1) {
-        oci8_define_bind_class("BinaryDouble", &bind_binary_double_vtable);
+        oci8_define_bind_class("BinaryDouble", &bind_binary_double_data_type, bind_binary_double_alloc);
     }
 }
-
-oci8_bind_t *oci8_get_bind(VALUE obj)
-{
-    oci8_base_t *base;
-    Check_Handle(obj, cOCI8BindTypeBase, base);
-    return (oci8_bind_t *)base;
-}