ruby-staci 2.2.9

data/docs/report-installation-issue.md

@@ -0,0 +1,50 @@
+# @title Report Installation Issues
+
+Report Installation Issues
+==========================
+
+Look at {file:docs/platform-specific-issues.md} and [the issues page on github][github] to check whether your issue is fixed or not.
+
+If it is a new one, post the following information to [github][].
+
+[github]: https://github.com/kubo/ruby-oci8/issues
+
+*    Messages printed out to the console
+
+*    `gem_make.out` if you install a gem
+
+*    Last 100 lines of 'ext/oci8/mkmf.log'
+
+     Get them as follows.
+
+         tail -100 ext/oci8/mkmf.log
+
+*    The results of the following commands:
+
+         file `which ruby`
+         ruby --version
+         ruby -r rbconfig -e "p RbConfig::CONFIG['host']"
+         ruby -r rbconfig -e "p RbConfig::CONFIG['CC']"
+         ruby -r rbconfig -e "p RbConfig::CONFIG['CFLAGS']"
+         ruby -r rbconfig -e "p RbConfig::CONFIG['LDSHARED']"
+         ruby -r rbconfig -e "p RbConfig::CONFIG['LDFLAGS']"
+         ruby -r rbconfig -e "p RbConfig::CONFIG['DLDLAGS']"
+         ruby -r rbconfig -e "p RbConfig::CONFIG['LIBS']"
+         ruby -r rbconfig -e "p RbConfig::CONFIG['GNU_LD']"
+         
+         # if you use gcc,
+         gcc --print-prog-name=ld
+         gcc --print-prog-name=as
+         
+         # Oracle full client
+         file $ORACLE_HOME/bin/oracle
+         
+         # Oracle Instant client. You need to change INSTANT_CLIENT_DIRECTORY.
+         file INSTANT_CLIENT_DIRECTORY/libclntsh.*
+         
+         echo $LD_LIBRARY_PATH
+         echo $LIBPATH              # AIX
+         echo $SHLIB_PATH           # HP-UX PA-RISC 32-bit ruby
+         echo $DYLD_LIBRARY_PATH    # Mac OS X
+         echo $LD_LIBRARY_PATH_32   # Solaris 32-bit ruby
+         echo $LD_LIBRARY_PATH_64   # Solaris 64-bit ruby

data/docs/timeout-parameters.md

@@ -0,0 +1,94 @@
+# @title Timeout Parameters
+
+Timeout Parameters
+==================
+
+The following timeout parameters are available since ruby-oci8 2.2.2.
+
+* tcp_connect_timeout
+* connect_timeout
+* send_timeout
+* recv_timeout
+
+For example:
+
+    OCI8.properties[:tcp_connect_timeout] = 10
+    OCI8.properties[:connect_timeout] = 15
+    OCI8.properties[:send_timeout] = 60
+    OCI8.properties[:recv_timeout] = 60
+
+These parameters are applied only to TCP/IP connections.
+
+The first two parameters `tcp_connect_timeout` and `connect_timeout`
+are applied only to [connect descriptors][connect descriptor] using [Easy Connect Naming Method][EZCONNECT].
+If you use a net service name, you should set [TRANSPORT_CONNECT_TIMEOUT][] and/or
+[CONNECT_TIMEOUT][] in the address descriptor in `tnsnames.ora` instead of these parameters.
+If you use easy connect naming method without any of `port`, `service_name`, `server` and `instance_name`,
+you need to use `//host` to distinguish it from a net service name.
+
+The next two parameters `send_timeout` and `recv_timeout` are available on Oracle 11g client
+or upper. Use these parameters to prevent a ruby process from being blocked by poor quality network.
+Otherwise, the ruby process may be blocked until TCP keepalive time (2 hours).
+
+See {file:docs/hanging-after-inactivity.md Hanging After a Long Period of Inactivity}
+for TCP keepalive time.
+
+tcp_connect_timeout
+-------------------
+
+`tcp_connect_timeout` is equivalent to [TCP.CONNECT_TIMEOUT][] in the client-side `sqlnet.ora` and
+[TRANSPORT_CONNECT_TIMEOUT][] in the address descriptor.
+See description about [TCP.CONNECT_TIMEOUT][] and [TRANSPORT_CONNECT_TIMEOUT][].
+
+connect_timeout
+---------------
+
+`connect_timeout` is equivalent to [SQLNET.OUTBOUND_CONNECT_TIMEOUT][] in the client-side `sqlnet.ora`
+and [CONNECT_TIMEOUT][] in the address description.
+See description about [SQLNET.OUTBOUND_CONNECT_TIMEOUT][] and [CONNECT_TIMEOUT][].
+
+Note: this parameter isn't equivalent to login timeout. It needs the following three
+steps to establish a database connection.
+
+1. Establish a TCP/IP connection.
+2. Establish an [Oracle Net][] connection on the TCP/IP connection.
+3. Authenticate and authorize the database user.
+
+`tcp_connect_timeout` sets the timeout of the first step.
+`connect_timeout` sets the total timeout of the first and the second steps.
+There is no timeout parameter to limit the maximum time of all three steps.
+
+Use `send_timeout` and `recv_timeout` in case that a TCP/IP connection stalls
+in the third step.
+
+send_timeout
+------------
+
+`send_timeout` is equivalent to [SQLNET.SEND_TIMEOUT][] in the client-side `sqlnet.ora`.
+See description about [SQLNET.SEND_TIMEOUT][].
+
+Note that the connection becomes unusable on timeout.
+
+See also {OCI8#send_timeout=}.
+
+recv_timeout
+------------
+
+`recv_timeout` is equivalent to [SQLNET.RECV_TIMEOUT][] in the client-side `sqlnet.ora`.
+See description about [SQLNET.RECV_TIMEOUT][].
+
+Note that the connection becomes unusable on timeout.
+
+See also {OCI8#recv_timeout=}.
+
+Note: This parameter must be larger than the longest SQL execution time in your applications. 
+
+[TCP.CONNECT_TIMEOUT]: http://docs.oracle.com/database/121/NETRF/sqlnet.htm#BIIDDACA
+[SQLNET.OUTBOUND_CONNECT_TIMEOUT]: https://docs.oracle.com/database/121/NETRF/sqlnet.htm#NETRF427
+[SQLNET.SEND_TIMEOUT]: http://docs.oracle.com/database/121/NETRF/sqlnet.htm#NETRF228
+[SQLNET.RECV_TIMEOUT]: http://docs.oracle.com/database/121/NETRF/sqlnet.htm#NETRF227
+[connect descriptor]: https://docs.oracle.com/database/121/NETRF/glossary.htm#BGBEDFBF
+[EZCONNECT]: https://docs.oracle.com/database/121/NETAG/naming.htm#NETAG255
+[CONNECT_TIMEOUT]: https://docs.oracle.com/database/121/NETRF/tnsnames.htm#NETRF666
+[TRANSPORT_CONNECT_TIMEOUT]: https://docs.oracle.com/database/121/NETRF/tnsnames.htm#NETRF1982
+[Oracle Net]: https://en.wikipedia.org/wiki/Oracle_Net_Services#Oracle_Net

data/ext/oci8/.document

@@ -0,0 +1,18 @@
+#attr.c
+#oci8lib.c
+#env.c
+
+oci8.c
+ocihandle.c
+bind.c
+stmt.c
+encoding.c
+error.c
+metadata.c
+
+lob.c
+ocinumber.c
+ocidatetime.c
+oradate.c
+object.c
+connection_pool.c

data/ext/oci8/MANIFEST

@@ -0,0 +1,18 @@
+MANIFEST
+attr.c
+bind.c
+const.c
+descriptor.c
+env.c
+error.c
+extconf.rb
+handle.c
+lob.c
+oci8.c
+oci8.h
+oraconf.rb
+oradate.c
+oranumber.c
+param.c
+stmt.c
+svcctx.c

data/ext/oci8/apiwrap.c.tmpl

@@ -0,0 +1,178 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
+<%= header_comment
+# This file is processed by apiwrap.rb.
+%>
+#define API_WRAP_C 1
+#include "apiwrap.h"
+#define BLOCKING_FUNCTION_EPILOGUE(svcctx) do { (svcctx)->executing_thread = Qnil; } while (0)
+
+<%
+prev_name = ''
+funcs.each do |f|
+  next if f.name == prev_name
+  prev_name = f.name
+%>
+/* <%=f.name%> */
+#if defined RUNTIME_API_CHECK
+typedef <%=f.ret%> (*oci8_<%=f.name%>_func_t)(<%=f.args.collect {|arg| arg.dcl}.join(', ')%>);
+static oci8_<%=f.name%>_func_t oci8_<%=f.name%>_func;
+#define <%=f.name%> oci8_<%=f.name%>_func
+#elif ORACLE_CLIENT_VERSION < <%=f.version_num%>
+#define <%=f.name%>(<%=f.args.collect {|a| a.name}.join(', ')%>) (0)
+#endif
+<%
+end # funcs.each
+
+funcs.each do |f|
+  if f.remote
+######################################################################
+##
+## remote API with runtime-check - start
+##
+######################################################################
+%>
+/*
+ * <%=f.name%>_nb
+ */
+typedef struct {
+    oci8_svcctx_t *svcctx;
+<%
+   f.ret != 'void'
+%>    <%= f.ret %> rv;
+<%
+   f.args.each do |a|
+%>    <%= a.dcl %>;
+<% end
+%>} oci8_<%=f.name%>_data_t;
+
+#if defined RUNTIME_API_CHECK
+int oci8_have_<%=f.name%>_nb;
+#endif
+
+#if defined RUNTIME_API_CHECK || ORACLE_CLIENT_VERSION >= <%=f.version_num%>
+static void *oci8_<%=f.name%>_cb(void *user_data)
+{
+    oci8_<%=f.name%>_data_t *data = (oci8_<%=f.name%>_data_t *)user_data;
+<% if f.ret == 'void'
+%>    <%=f.name%>(<%= f.args.collect do |a| 'data->' + a.name; end.join(', ') %>);
+<% else
+%>    data->rv = <%=f.name%>(<%= f.args.collect do |a| 'data->' + a.name; end.join(', ') %>);
+<% end %>
+<% if f.ret == 'sword'
+%>    BLOCKING_FUNCTION_EPILOGUE(data->svcctx);
+    return (void*)(VALUE)data->rv;
+<% else
+%>    BLOCKING_FUNCTION_EPILOGUE(data->svcctx);
+    return NULL;
+<% end %>
+}
+#else
+#define oci8_<%=f.name%>_cb NULL
+#endif
+
+<%=f.ret%> oci8_<%=f.name%>_nb(oci8_svcctx_t *svcctx, <%=f.args.collect {|arg| arg.dcl}.join(', ')%>, const char *file, int line)
+{
+    if (have_<%=f.name%>_nb) {
+        oci8_<%=f.name%>_data_t data;
+        data.svcctx = svcctx;
+<% f.args.each do |a|
+%>        data.<%=a.name%> = <%=a.name%>;
+<% end
+%>        oci8_call_without_gvl(svcctx, oci8_<%=f.name%>_cb, &data);
+<%   if f.ret != 'void'
+%>        return data.rv;
+<% end
+%>    } else {
+        rb_raise(rb_eRuntimeError, "undefined OCI function %s is called", "<%=f.name%>_nb");
+    }
+}
+<%
+######################################################################
+##
+## remote API with runtime-check - end
+##
+######################################################################
+  else
+######################################################################
+##
+## local API with runtime-check - start
+##
+######################################################################
+%>
+/*
+ * <%=f.name%>
+ */
+#if defined RUNTIME_API_CHECK
+int oci8_have_<%=f.name%>;
+#endif
+
+<%=f.ret%> oci8_<%=f.name%>(<%=f.args.collect {|arg| arg.dcl}.join(', ')%>, const char *file, int line)
+{
+    if (have_<%=f.name%>) {
+<%  if f.ret == 'void'
+%>        <%=f.name%>(<%=f.args.collect {|arg| arg.name}.join(', ')%>);
+<%  else
+%>        return <%=f.name%>(<%=f.args.collect {|arg| arg.name}.join(', ')%>);
+<% end
+%>    } else {
+<%  if f.code_if_not_found %><%=f.code_if_not_found.split("\n").collect {|line| "        " + line}.join("\n")%>
+<% else
+%>        rb_raise(rb_eRuntimeError, "undefined OCI function %s is called", "<%=f.name%>");
+<% end
+%>    }
+}
+<%
+######################################################################
+##
+## local API with runtime-check - end
+##
+######################################################################
+  end
+end # funcs.each
+######################################################################
+##
+## RUNTIME_API_CHECK
+##
+######################################################################
+current_version_num = funcs[0].version_num
+current_version_str = funcs[0].version_str
+have_vars = []
+%>
+#if defined RUNTIME_API_CHECK
+int oracle_client_version;
+
+void Init_oci8_apiwrap(void)
+{
+    oracle_client_version = 0;
+<%
+funcs.each do |f|
+  if current_version_num != f.version_num
+    unless have_vars.empty?
+%>    /* pass Oracle <%=current_version_str%> API */
+    oracle_client_version = <%=current_version_num%>;
+<%    have_vars.each do |v|
+%>    <%=v%> = 1;
+<%    end
+    end
+    have_vars = []
+    current_version_num = f.version_num
+    current_version_str = f.version_str
+%>
+    /*
+     * checking Oracle <%=f.version_str%> API
+     */
+<%
+  end
+  have_vars << 'have_' + f.name + (f.remote ? '_nb' : '')
+%>    oci8_<%=f.name%>_func = (oci8_<%=f.name%>_func_t)oci8_find_symbol("<%=f.name%>");
+    if (oci8_<%=f.name%>_func == NULL)
+        return;
+<%
+end
+%>    /* pass Oracle <%=current_version_str%> API */
+    oracle_client_version = <%=current_version_num%>;
+<%    have_vars.each do |v|
+%>    <%=v%> = 1;
+<%    end
+%>}
+#endif /* RUNTIME_API_CHECK */

data/ext/oci8/apiwrap.h.tmpl

@@ -0,0 +1,61 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
+<%= header_comment
+# This file is processed by apiwrap.rb.
+%>
+#ifndef APIWRAP_H
+#define APIWRAP_H 1
+#include <oci8.h>
+
+#if defined RUNTIME_API_CHECK
+void Init_oci8_apiwrap(void);
+extern int oracle_client_version;
+#else
+#define oracle_client_version ORACLE_CLIENT_VERSION
+#endif
+<%
+funcs.each do |f|
+  if f.remote
+%>
+/*
+ * <%=f.name%>
+ *   version: <%=f.version_str%>
+ *   remote:  true
+ */
+<%=f.ret%> oci8_<%=f.name%>_nb(oci8_svcctx_t *svcctx, <%=f.args.collect {|arg| arg.dcl}.join(', ')%>, const char *file, int line);
+#define <%=f.name%>_nb(svcctx, <%=f.args.collect do |a| a.name; end.join(', ')%>) \
+      oci8_<%=f.name%>_nb(svcctx, <%=f.args.collect do |a| a.name; end.join(', ')%>, __FILE__, __LINE__)
+#if defined RUNTIME_API_CHECK
+extern int oci8_have_<%=f.name%>_nb;
+#define have_<%=f.name%>_nb oci8_have_<%=f.name%>_nb
+#elif ORACLE_CLIENT_VERSION >= <%=f.version_num%>
+#define have_<%=f.name%>_nb (1)
+#else
+#define have_<%=f.name%>_nb (0)
+#endif
+<%
+  else
+%>
+/*
+ * <%=f.name%>
+ *   version: <%=f.version_str%>
+ *   remote:  false
+ */
+<%=f.ret%> oci8_<%=f.name%>(<%=f.args.collect {|arg| arg.dcl}.join(', ')%>, const char *file, int line);
+#ifndef API_WRAP_C
+#undef <%=f.name%>
+#define <%=f.name%>(<%=f.args.collect do |a| a.name; end.join(', ')%>) \
+      oci8_<%=f.name%>(<%=f.args.collect do |a| a.name; end.join(', ')%>, __FILE__, __LINE__)
+#endif
+#if defined RUNTIME_API_CHECK
+extern int oci8_have_<%=f.name%>;
+#define have_<%=f.name%> oci8_have_<%=f.name%>
+#elif ORACLE_CLIENT_VERSION >= <%=f.version_num%>
+#define have_<%=f.name%> (1)
+#else
+#define have_<%=f.name%> (0)
+#endif
+<%
+  end
+end # funcs.each
+%>
+#endif /* APIWRAP_H */

data/ext/oci8/apiwrap.rb

@@ -0,0 +1,96 @@
+require 'yaml'
+require 'erb'
+
+class ArgDef
+  attr_reader :dcl
+  attr_reader :name
+
+  def initialize(arg)
+    /(\w+)\s*$/ =~ arg
+    /\(\*(\w+)\)/ =~ arg if $1.nil?
+    @dcl = arg
+    @name = $1
+  end
+end
+
+class FuncDef
+  attr_reader :name
+  attr_reader :version
+  attr_reader :version_num
+  attr_reader :version_str
+  attr_reader :remote
+  attr_reader :args
+  attr_reader :ret
+  attr_reader :code_if_not_found
+
+  def initialize(key, val)
+    if key[-3..-1] == '_nb'
+      @name = key[0..-4]
+      @remote = true
+    else
+      @name = key
+      @remote = false
+    end
+    ver = val[:version]
+    ver_major = (ver / 100)
+    ver_minor = (ver / 10) % 10
+    ver_update = ver % 10
+    @version = if ver_major >= 18
+                 ((ver_major << 24) | (ver_minor << 16) | (ver_update << 12))
+               else
+                 ((ver_major << 24) | (ver_minor << 20) | (ver_update << 12))
+               end
+    case @version
+    when 0x08000000; @version_num = 'ORAVER_8_0'
+    when 0x08100000; @version_num = 'ORAVER_8_1'
+    when 0x09000000; @version_num = 'ORAVER_9_0'
+    when 0x09200000; @version_num = 'ORAVER_9_2'
+    when 0x0a100000; @version_num = 'ORAVER_10_1'
+    when 0x0a200000; @version_num = 'ORAVER_10_2'
+    when 0x0b100000; @version_num = 'ORAVER_11_1'
+    when 0x12000000; @version_num = 'ORAVER_18'
+    end
+    @version_str = "#{ver_major}.#{ver_minor}.#{ver_update}"
+    @ret = val[:ret] || 'sword'
+    @args = val[:args].collect do |arg|
+      ArgDef.new(arg)
+    end
+    @code_if_not_found = val[:code_if_not_found]
+  end
+end
+
+def create_apiwrap
+  funcs = []
+  YAML.load(open(File.dirname(__FILE__) + '/apiwrap.yml')).each do |key, val|
+    funcs << FuncDef.new(key, val)
+  end
+  funcs.sort! do |a, b|
+    if a.version == b.version
+      a.name <=> b.name
+    else
+      a.version <=> b.version
+    end
+  end
+
+  header_comment = <<EOS.chomp
+/*
+ * This file was created by apiwrap.rb.
+ * Don't edit this file manually.
+ */
+EOS
+#'
+
+  erb = ERB.new(open(File.dirname(__FILE__) + '/apiwrap.h.tmpl').read)
+  open('apiwrap.h', 'w') do |fd|
+    fd.write(erb.result(binding))
+  end
+
+  erb = ERB.new(open(File.dirname(__FILE__) + '/apiwrap.c.tmpl').read)
+  open('apiwrap.c', 'w') do |fd|
+    fd.write(erb.result(binding))
+  end
+end
+
+if $0 == __FILE__
+  create_apiwrap
+end