ruby-oci8 2.2.3 → 2.2.12

data/ext/oci8/oci8.h

@@ -21,8 +21,23 @@ extern "C"
 }
 #endif
 
+/*
+ * Oracle version number format in 32-bit integer.
+ *
+ * Oracle 12c or earier                     Oracle 18c or later
+ *
+ * hexadecimal ->  dotted version number    hexadecimal ->  dotted version number
+ *  0c102304   ->  12.1.2.3.4                12012034   ->  18.1.2.3.4
+ *                 ^  ^ ^ ^ ^                               ^  ^ ^ ^ ^
+ *  0c ------------'  | | | |  2 bytes       12 ------------'  | | | |  2 bytes
+ *    1 --------------' | | |  1 byte          01 -------------' | | |  2 bytes
+ *     02 --------------' | |  2 bytes           2 --------------' | |  1 byte
+ *       3 ---------------' |  1 byte             03 --------------' |  2 bytes
+ *        04 ---------------'  2 bytes              4 ---------------'  1 byte
+ */
 #define ORAVERNUM(major, minor, update, patch, port_update) \
-    (((major) << 24) | ((minor) << 20) | ((update) << 12) | ((patch) << 8) | (port_update))
+    (((major) >= 18) ? (((major) << 24) | ((minor) << 16) | ((update) << 12) | ((patch) << 4) | (port_update)) \
+                     : (((major) << 24) | ((minor) << 20) | ((update) << 12) | ((patch) << 8) | (port_update)))
 
 #define ORAVER_8_0 ORAVERNUM(8, 0, 0, 0, 0)
 #define ORAVER_8_1 ORAVERNUM(8, 1, 0, 0, 0)
@@ -32,6 +47,7 @@ extern "C"
 #define ORAVER_10_2 ORAVERNUM(10, 2, 0, 0, 0)
 #define ORAVER_11_1 ORAVERNUM(11, 1, 0, 0, 0)
 #define ORAVER_12_1 ORAVERNUM(12, 1, 0, 0, 0)
+#define ORAVER_18 ORAVERNUM(18, 0, 0, 0, 0)
 
 #include "extconf.h"
 #include <ruby/encoding.h>
@@ -73,88 +89,6 @@ typedef orasb8 sb8;
 #endif
 #endif
 
-/*
- * Use TypedData on ruby 1.9.3 and later.
- */
-#ifndef HAVE_RB_DATA_TYPE_T_FUNCTION
-
-/*
- * Don't use TypedData even though ruby 1.9.2 has it because the
- * definitions are slightly different from ruby 1.9.3 and later.
- */
-#define rb_data_type_t oci8_data_type_t
-#undef TypedData_Make_Struct
-#undef TypedData_Wrap_Struct
-#undef TypedData_Get_Struct
-#undef RTYPEDDATA_DATA
-#undef RUBY_DEFAULT_FREE
-
-/*
- * To pass compilation on ruby 1.9.2 and earlier.
- */
-typedef struct oci8_data_type_struct rb_data_type_t;
-struct oci8_data_type_struct {
-    const char *wrap_struct_name;
-    struct {
-        void (*dmark)(void*);
-        void (*dfree)(void*);
-        size_t (*dsize)(const void *);
-    } function;
-    const rb_data_type_t *parent;
-    void *data;
-};
-#define TypedData_Make_Struct(klass, type, data_type, sval) \
-             Data_Make_Struct((klass), type, (data_type)->function.dmark, (data_type)->function.dfree, (sval))
-#define TypedData_Wrap_Struct(klass, data_type, sval) \
-             Data_Wrap_Struct((klass), (data_type)->function.dmark, (data_type)->function.dfree, (sval))
-#define TypedData_Get_Struct(obj, type, data_type, sval) \
-             Data_Get_Struct((obj), type, (sval))
-#define RTYPEDDATA_DATA(obj) DATA_PTR(obj)
-#define RUBY_DEFAULT_FREE xfree
-#endif
-
-/* a new function in ruby 1.9.3.
- * define a compatible macro for ruby 1.9.2 or lower.
- */
-#ifndef HAVE_RB_CLASS_SUPERCLASS
-#ifdef RCLASS_SUPER
-#define rb_class_superclass(cls) RCLASS_SUPER(cls)
-#else
-#define rb_class_superclass(cls) (RCLASS(cls)->super)
-#endif
-#endif
-
-/* new macros in ruby 2.1.0
- */
-#ifndef RARRAY_AREF
-#define RARRAY_AREF(a, i)    (RARRAY_PTR(a)[i])
-#endif
-#ifndef RARRAY_CONST_PTR
-#define RARRAY_CONST_PTR(a)  RARRAY_PTR(a)
-#endif
-#ifndef RB_OBJ_WRITE
-#define RB_OBJ_WRITE(a, slot, b)   do {*(slot) = (b);} while (0)
-#endif
-#ifndef RB_OBJ_WRITTEN
-#define RB_OBJ_WRITTEN(a, oldv, b) do {(void)oldv;} while (0)
-#endif
-
-/* new macros in ruby 2.4.0
- */
-#ifndef ALWAYS_INLINE
-#if defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
-/* gcc version >= 3.1 */
-#define ALWAYS_INLINE(x) __attribute__((always_inline)) x
-#endif
-#ifdef _MSC_VER
-/* microsoft c */
-#define ALWAYS_INLINE(x) __forceinline x
-#endif
-#ifndef ALWAYS_INLINE
-#define ALWAYS_INLINE(x) x
-#endif
-#endif /* ALWAYS_INLINE */
-
 /* macros depends on the compiler.
  *  LIKELY(x)      hint for the compiler that 'x' is 1(TRUE) in many cases.
  *  UNLIKELY(x)    hint for the compiler that 'x' is 0(FALSE) in many cases.
@@ -316,6 +250,7 @@ typedef struct oci8_svcctx {
     const oci8_logoff_strategy_t *logoff_strategy;
     OCISession *usrhp;
     OCIServer *srvhp;
+    ub4 server_version;
     rb_pid_t pid;
     unsigned char state;
     char is_autocommit;
@@ -340,7 +275,8 @@ typedef struct {
 } oci8_exec_sql_var_t;
 
 #define oci8_raise(err, status, stmt) oci8_do_raise(err, status, stmt, __FILE__, __LINE__)
-#define oci8_env_raise(err, status) oci8_do_env_raise(err, status, __FILE__, __LINE__)
+#define oci8_env_raise(env, status) oci8_do_env_raise(env, status, 0, __FILE__, __LINE__)
+#define oci8_env_free_and_raise(env, status) oci8_do_env_raise(env, status, 1, __FILE__, __LINE__)
 #define oci8_raise_init_error() oci8_do_raise_init_error(__FILE__, __LINE__)
 #define oci8_raise_by_msgno(msgno, default_msg) oci8_do_raise_by_msgno(msgno, default_msg, __FILE__, __LINE__)
 
@@ -364,7 +300,7 @@ OCIEnv *oci8_make_envhp(void);
 extern oci8_tls_key_t oci8_tls_key; /* native thread key */
 OCIError *oci8_make_errhp(void);
 
-static inline OCIError *oci8_get_errhp()
+static inline OCIError *oci8_get_errhp(void)
 {
     OCIError *errhp = (OCIError *)oci8_tls_get(oci8_tls_key);
     return LIKELY(errhp != NULL) ? errhp : oci8_make_errhp();
@@ -406,7 +342,8 @@ void *oci8_check_typeddata(VALUE obj, const oci8_handle_data_type_t *data_type,
 extern VALUE eOCIException;
 extern VALUE eOCIBreak;
 void Init_oci8_error(void);
-NORETURN(void oci8_do_env_raise(OCIEnv *, sword status, const char *file, int line));
+NORETURN(void oci8_do_raise(OCIError *errhp, sword status, OCIStmt *stmthp, const char *file, int line));
+NORETURN(void oci8_do_env_raise(OCIEnv *envhp, sword status, int free_envhp, const char *file, int line));
 NORETURN(void oci8_do_raise_init_error(const char *file, int line));
 sb4 oci8_get_error_code(OCIError *errhp);
 VALUE oci8_get_error_message(ub4 msgno, const char *default_msg);
@@ -488,8 +425,8 @@ OCINumber *oci8_dbl_to_onum(OCINumber *result, double dbl, OCIError *errhp);
 void Init_oci_datetime(void);
 VALUE oci8_make_ocidate(OCIDate *od);
 OCIDate *oci8_set_ocidate(OCIDate *od, VALUE val);
-VALUE oci8_make_ocidatetime(OCIDateTime *dttm);
-OCIDateTime *oci8_set_ocidatetime(OCIDateTime *dttm, VALUE val);
+VALUE oci8_make_ocitimestamp(OCIDateTime *dttm, boolean have_tz);
+OCIDateTime *oci8_set_ocitimestamp_tz(OCIDateTime *dttm, VALUE val, VALUE svc);
 VALUE oci8_make_interval_ym(OCIInterval *s);
 VALUE oci8_make_interval_ds(OCIInterval *s);
 
@@ -514,6 +451,13 @@ void Init_oci8_win32(VALUE cOCI8);
 /* hook_funcs.c */
 void oci8_install_hook_functions(void);
 void oci8_shutdown_sockets(void);
+#ifdef HAVE_PLTHOOK
+extern int oci8_cancel_read_at_exit;
+extern int oci8_tcp_keepalive_time;
+#else
+#define oci8_cancel_read_at_exit (-1)
+#define oci8_tcp_keepalive_time (-1)
+#endif
 
 #define OCI8StringValue(v) do { \
     StringValue(v); \

data/ext/oci8/oci8lib.c

@@ -7,6 +7,10 @@
 #ifdef HAVE_RUBY_THREAD_H
 #include <ruby/thread.h>
 #endif
+#if defined(HAVE_PLTHOOK) && !defined(WIN32)
+#include <dlfcn.h>
+#include "plthook.h"
+#endif
 
 ID oci8_id_at_last_error;
 ID oci8_id_get;
@@ -67,14 +71,130 @@ static VALUE bind_base_alloc(VALUE klass)
     rb_raise(rb_eNameError, "private method `new' called for %s:Class", rb_class2name(klass));
 }
 
+#if defined(HAVE_PLTHOOK) && !defined(WIN32) && !defined(__CYGWIN__) && !defined(TRUFFLERUBY)
+static const char *find_libclntsh(void *handle)
+{
+    void *symaddr = dlsym(handle, "OCIEnvCreate");
+    Dl_info info;
+#ifdef __APPLE__
+    const char *basename = "libclntsh.dylib";
+#else
+    const char *basename = "libclntsh.so";
+#endif
+    const char *p;
+
+    if (symaddr == NULL) {
+        return NULL;
+    }
+    if (dladdr(symaddr, &info) == 0) {
+        return NULL;
+    }
+    if ((p = strrchr(info.dli_fname, '/')) == NULL) {
+        return NULL;
+    }
+    if (strncmp(p + 1, basename, strlen(basename)) != 0) {
+        return NULL;
+    }
+    return info.dli_fname;
+}
+
+/*
+ * Symbol prefix depends on the platform.
+ *  Linux x86_64 - no prefix
+ *  Linux x86_32 - "_"
+ *  macOS        - "@_"
+ */
+static const char *find_symbol_prefix(plthook_t *ph, size_t *len)
+{
+    unsigned int pos = 0;
+    const char *name;
+    void **addr;
+
+    while (plthook_enum(ph, &pos, &name, &addr) == 0) {
+        const char *p = strstr(name, "OCIEnvCreate");
+        if (p != NULL) {
+            *len = p - name;
+            return name;
+        }
+    }
+    return NULL;
+}
+
+/*
+ * Fix PLT entries against function interposition.
+ * See: http://www.rubydoc.info/github/kubo/ruby-oci8/file/docs/ldap-auth-and-function-interposition.md
+ */
+static void rebind_internal_symbols(void)
+{
+    const char *libfile;
+    void *handle;
+    int flags = RTLD_LAZY | RTLD_NOLOAD;
+    plthook_t *ph;
+    unsigned int pos = 0;
+    const char *name;
+    void **addr;
+    const char *prefix;
+    size_t prefix_len;
+
+#ifdef RTLD_FIRST
+    flags |= RTLD_FIRST; /* for macOS */
+#endif
+
+    libfile = find_libclntsh(RTLD_DEFAULT); /* normal case */
+    if (libfile == NULL) {
+        libfile = find_libclntsh(RTLD_NEXT); /* special case when OCIEnvCreate is hooked by LD_PRELOAD */
+    }
+    if (libfile == NULL) {
+        return;
+    }
+    handle = dlopen(libfile, flags);
+    if (handle == NULL) {
+        return;
+    }
+    if (plthook_open(&ph, libfile) != 0) {
+        dlclose(handle);
+        return;
+    }
+    prefix = find_symbol_prefix(ph, &prefix_len);
+    if (prefix == NULL) {
+        dlclose(handle);
+        plthook_close(ph);
+        return;
+    }
+    while (plthook_enum(ph, &pos, &name, &addr) == 0) {
+        void *funcaddr;
+        if (prefix_len != 0) {
+            if (strncmp(name, prefix, prefix_len) != 0) {
+                continue;
+            }
+            name += prefix_len;
+        }
+        if (strncmp(name, "OCI", 3) == 0) {
+            /* exclude functions starting with OCI not to prevent LD_PRELOAD hooking */
+            continue;
+        }
+        funcaddr = dlsym(handle, name);
+        if (funcaddr != NULL && *addr != funcaddr) {
+            /* If libclntsh.so exports and imports same functions, their
+             * PLT entries are forcedly modified to point to itself not
+             * to use functions in other libraries.
+             */
+            *addr = funcaddr;
+        }
+    }
+    plthook_close(ph);
+    dlclose(handle);
+}
+#endif
+
 #ifdef _WIN32
 __declspec(dllexport)
 #endif
 void
-Init_oci8lib()
+Init_oci8lib(void)
 {
     VALUE cOCI8;
-    OCIEnv *envhp;
+    OCIEnv *envhp = NULL;
     OCIError *errhp;
     sword rv;
 
@@ -106,6 +226,9 @@ Init_oci8lib()
         oracle_client_version = ORAVERNUM(major, minor, update, patch, port_update);
     }
 #endif
+#if defined(HAVE_PLTHOOK) && !defined(WIN32) && !defined(__CYGWIN__) && !defined(TRUFFLERUBY)
+    rebind_internal_symbols();
+#endif
 
     oci8_id_at_last_error = rb_intern("@last_error");
     oci8_id_get = rb_intern("get");
@@ -153,7 +276,11 @@ Init_oci8lib()
     /* allocate a temporary errhp to pass Init_oci_number() */
     rv = OCIEnvCreate(&envhp, oci8_env_mode, NULL, NULL, NULL, NULL, 0, NULL);
     if (rv != OCI_SUCCESS) {
-        oci8_raise_init_error();
+        if (envhp != NULL) {
+            oci8_env_free_and_raise(envhp, rv);
+        } else {
+            oci8_raise_init_error();
+        }
     }
     rv = OCIHandleAlloc(envhp, (dvoid *)&errhp, OCI_HTYPE_ERROR, 0, NULL);
     if (rv != OCI_SUCCESS)
@@ -334,6 +461,7 @@ sword oci8_call_without_gvl(oci8_svcctx_t *svcctx, void *(*func)(void *), void *
         parg.func = func;
         parg.data = data;
         rv = (sword)rb_protect(protected_call, (VALUE)&parg, &state);
+        RB_OBJ_WRITE(svcctx->base.self, &svcctx->executing_thread, Qnil);
         if (state) {
             rb_jump_tag(state);
         }
@@ -354,8 +482,8 @@ typedef struct {
     OCIStmt *stmtp;
 } cb_arg_t;
 
-static VALUE exec_sql(cb_arg_t *arg);
-static VALUE ensure_func(cb_arg_t *arg);
+static VALUE exec_sql(VALUE varg);
+static VALUE ensure_func(VALUE varg);
 
 /*
  * utility function to execute a single SQL statement
@@ -376,13 +504,14 @@ sword oci8_exec_sql(oci8_svcctx_t *svcctx, const char *sql_text, ub4 num_define_
     return (sword)rb_ensure(exec_sql, (VALUE)&arg, ensure_func, (VALUE)&arg);
 }
 
-static VALUE exec_sql(cb_arg_t *arg)
+static VALUE exec_sql(VALUE varg)
 {
+    cb_arg_t *arg = (cb_arg_t *)varg;
     ub4 pos;
     sword rv;
 
     chker2(OCIStmtPrepare2(arg->svcctx->base.hp.svc, &arg->stmtp, oci8_errhp, 
-                           (text*)arg->sql_text, strlen(arg->sql_text), NULL, 0,
+                           (text*)arg->sql_text, (ub4)strlen(arg->sql_text), NULL, 0,
                            OCI_NTV_SYNTAX, OCI_DEFAULT),
            &arg->svcctx->base);
     for (pos = 0; pos < arg->num_define_vars; pos++) {
@@ -419,8 +548,9 @@ static VALUE exec_sql(cb_arg_t *arg)
     return (VALUE)rv;
 }
 
-static VALUE ensure_func(cb_arg_t *arg)
+static VALUE ensure_func(VALUE varg)
 {
+    cb_arg_t *arg = (cb_arg_t *)varg;
     if (arg->stmtp != NULL) {
         OCIStmtRelease(arg->stmtp, oci8_errhp, NULL, 0, OCI_DEFAULT);
     }
@@ -431,6 +561,24 @@ static VALUE ensure_func(cb_arg_t *arg)
 
 #ifndef _WIN32
 #include <dlfcn.h>
+static void *load_file(const char *filename, int flags, VALUE errors)
+{
+    void *handle = dlopen(filename, flags);
+
+    if (handle == NULL) {
+        char *err = dlerror();
+        VALUE msg;
+
+        if (strstr(err, filename) == NULL) {
+            msg = rb_sprintf("%s: %s", filename, err);
+            msg = rb_enc_associate_index(msg, rb_locale_encindex());
+        } else {
+            msg = rb_locale_str_new_cstr(err);
+        }
+        rb_ary_push(errors, msg);
+    }
+    return handle;
+}
 #endif
 
 void *oci8_find_symbol(const char *symbol_name)
@@ -473,58 +621,50 @@ void *oci8_find_symbol(const char *symbol_name)
             "libclntsh.sl.12.1",
             "libclntsh.sl.11.1",
             "libclntsh.sl.10.1",
-            "libclntsh.sl.9.0",
-            "libclntsh.sl.8.0",
 #elif defined(__APPLE__)
             /* Mac OS X */
+            "libclntsh.dylib",
             "libclntsh.dylib.12.1",
             "libclntsh.dylib.11.1",
             "libclntsh.dylib.10.1",
 #else
             /* Linux, Solaris and HP-UX(IA64) */
+            "libclntsh.so",
             "libclntsh.so.12.1",
             "libclntsh.so.11.1",
             "libclntsh.so.10.1",
-            "libclntsh.so.9.0",
-            "libclntsh.so.8.0",
 #endif
         };
 #define NUM_SONAMES (sizeof(sonames)/sizeof(sonames[0]))
+#if defined(_AIX) /* AIX */
+#define BASE_SONAME "libclntsh.a(shr.o)"
+#elif defined(__hppa) /* HP-UX(PA-RISC) */
+#define BASE_SONAME "libclntsh.sl"
+#elif !defined(__CYGWIN__) && !defined(__APPLE__)
+#define BASE_SONAME "libclntsh.so"
+#endif
         size_t idx;
-        volatile VALUE err = rb_ary_new();
+        VALUE err = rb_ary_new();
 
 #ifdef _AIX
 #define DLOPEN_FLAG (RTLD_LAZY|RTLD_GLOBAL|RTLD_MEMBER)
 #else
 #define DLOPEN_FLAG (RTLD_LAZY|RTLD_GLOBAL)
 #endif
-        for (idx = 0; idx < NUM_SONAMES; idx++) {
-            handle = dlopen(sonames[idx], DLOPEN_FLAG);
-            if (handle != NULL) {
-                break;
-            }
-            rb_ary_push(err, rb_locale_str_new_cstr(dlerror()));
+#ifdef BASE_SONAME
+        char *oracle_home = getenv("ORACLE_HOME");
+
+        if (oracle_home != NULL) {
+            VALUE fname = rb_str_buf_cat2(rb_str_buf_new_cstr(oracle_home),  "/lib/" BASE_SONAME);
+            handle = load_file(StringValueCStr(fname), DLOPEN_FLAG, err);
+            RB_GC_GUARD(fname);
+        }
+#endif
+        for (idx = 0; handle == NULL && idx < NUM_SONAMES; idx++) {
+            handle = load_file(sonames[idx], DLOPEN_FLAG, err);
         }
         if (handle == NULL) {
-            VALUE msg;
-            const VALUE *arr = RARRAY_CONST_PTR(err);
-
-            msg = rb_str_buf_new(NUM_SONAMES * 50);
-            for (idx = 0; idx < NUM_SONAMES; idx++) {
-                const char *errmsg = RSTRING_PTR(arr[idx]);
-                if (idx != 0) {
-                    rb_str_buf_cat2(msg, " ");
-                }
-                if (strstr(errmsg, sonames[idx]) == NULL) {
-                    /* prepend "soname: " if soname is not found in
-                     * the error message.
-                     */
-                    rb_str_buf_cat2(msg, sonames[idx]);
-                    rb_str_buf_cat2(msg, ": ");
-                }
-                rb_str_buf_append(msg, arr[idx]);
-                rb_str_buf_cat2(msg, ";");
-            }
+            VALUE msg = rb_ary_join(err, rb_usascii_str_new_cstr("; "));
             rb_exc_raise(rb_exc_new3(rb_eLoadError, msg));
         }
     }