ruby-oci8 2.2.4 → 2.2.4.1

data/ChangeLog

@@ -1,6 +1,21 @@
+2017-06-17  Kubo Takehiro <kubo@jiubao.org>
+	* NEWS: Add changes between 2.2.4 and 2.2.4.1
+	* lib/oci8/version.rb: Update to 2.2.4.1
+	* lib/oci8/version.rb: Fix URL links
+	* docs/hanging-after-inactivity.md: Revised
+
+2017-06-16  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/extconf.rb, ext/oci8/hook_funcs.c, ext/oci8/oci8lib.c:
+	    Fix to pass compilation on cygwin.
+	* mkpkg-win32.rb: Add tests on cygwin.
+
+2017-06-16  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/hook_funcs.c: Fix the calling convention of setsockopt
+	    on Windows x86.
+
 2017-06-11  Kubo Takehiro <kubo@jiubao.org>
 	* NEWS: Add changes between 2.2.3 and 2.2.4.
-	* lib/oci8/version.rb: update to 2.2.3.
+	* lib/oci8/version.rb: update to 2.2.4.
 	* docs/ldap-auth-and-function-interposition.md,
 	  docs/hanging-after-inactivity.md: updated
 

data/NEWS

@@ -1,5 +1,20 @@
 # @markup markdown
 
+2.2.4.1
+=======
+
+Fixed issue
+-----------
+
+### Fix invalid function calls when TCP keepalive time parameter is set on Windows x86
+
+When TCP keepalive time parameter is set, The win32 API `setsockopt` was hooked
+with incorrect calling convention on Windows x86. As far as I checked it doesn't
+cause bad effects. But it is by chance. If the code in `oci.dll` is optimized
+differently, it may cause unexpected behavior.
+
+### Fix compilation errors in 2.2.4 on cygwin
+
 2.2.4
 =====
 

data/docs/hanging-after-inactivity.md

@@ -6,13 +6,13 @@ Hanging After a Long Period of Inactivity
 When a database connection hangs after a long period of inactivity,
 this document may help you.
 
-When a firewall resides between Oracle database server and client, the
-firewall sometimes drops inactive connections as dead ones. If a
+When a firewall or a NAT proxy resides between Oracle database server
+and client, it sometimes drops inactive connections as dead ones. If a
 client connects to an Oracle server and tries to use the connection
-after a long sleep (> 1 hour), the client may hang due to the
+after a long sleep (> 1 hour), the client may hang in an effort to use the
 dropped connection. This issue will be solved by setting TCP keepalive
 packets whose keepalive time parameter is smaller than the inactive
-connection timeout in the firewall.
+connection timeout.
 
 TCP keepalive is enabled by [(ENABLE=broken)][] in a connect
 descriptor. If you use easy connect naming such as `//hostname/service_name`,
@@ -28,28 +28,29 @@ This is equivalent to the following:
     conn = OCI8.new(username, password, connect_descriptor)
 
 The default TCP keepalive time is two hours, which may be larger
-than the inactive connection timeout in the firewall. The default
+than the inactive connection timeout. The default
 value in the system is configurable via [procfs and sysctl on Linux][]
 or [registry parameters on Windows][]. If you have no privilege to
-customize the system, you can change it in an application layer
-by the tcp_keepalive_time property.
+customize the system, you can change per-connection keepalive time
+by the `tcp_keepalive_time` property.
 
     OCI8.properties[:tcp_keepalive_time] = 600 # 10 minutes
 
-`OCI8.properties[:tcp_keepalive_time]` is supported on the following
-platforms since ruby-oci8 2.2.4.
+It is supported on the following platforms since ruby-oci8 2.2.4.
 
 * Linux i386 and x86_64
 * macOS
 * Windows x86 and x64
 * Solaris x86_64
 
+When it is set on unsupported platforms, you get `NotImplementedError`.
+
 This feature is implemented with hackish way. When
 `tcp_keepalive_time` is set, Oracle client library's
 procedure linkage table is modified to intercept [setsockopt][] system
-calls. When Oracle client library issues a system call which enables
-TCP keepalive, ruby-oci8 changes the TCP keepalive time of the
-connection immediately after the system call.
+call. When Oracle client library issues the system call which enables
+TCP keepalive, [ruby-oci8 changes][] the per-connection TCP keepalive time
+immediately.
 
 I hope that Oracle adds a new OCI handle attribute to support this
 feature natively in the future.
@@ -59,3 +60,4 @@ feature natively in the future.
 [registry parameters on Windows]: https://blogs.technet.microsoft.com/nettracer/2010/06/03/things-that-you-may-want-to-know-about-tcp-keepalives/
 [plthook]: https://github.com/kubo/plthook
 [setsockopt]: http://pubs.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html
+[ruby-oci8 changes]: https://github.com/kubo/ruby-oci8/blob/ruby-oci8-2.2.4/ext/oci8/hook_funcs.c#L302-L318

data/ext/oci8/extconf.rb

@@ -160,6 +160,7 @@ if xsystem(cc_command("").gsub(CONFTEST_C, File.dirname(__FILE__) + "/" + plthoo
   $objs << "hook_funcs.o"
   $defs << "-DHAVE_PLTHOOK"
   have_library('dbghelp', 'ImageDirectoryEntryToData', ['windows.h', 'dbghelp.h']) if RUBY_PLATFORM =~ /cygwin/
+  $libs += ' -lws2_32' if RUBY_PLATFORM =~ /cygwin/
 else
   puts "no"
 end

data/ext/oci8/hook_funcs.c

@@ -4,16 +4,26 @@
  *
  * Copyright (C) 2015 Kubo Takehiro <kubo@jiubao.org>
  */
+#if defined(_WIN32) || defined(__CYGWIN__)
+#define WINDOWS
+#include <winsock2.h>
+#endif
 #include "oci8.h"
 #include "plthook.h"
-#ifndef WIN32
+#ifdef __CYGWIN__
+#undef boolean /* boolean defined in oratypes.h coflicts with that in windows.h */
+#endif
+#ifdef WINDOWS
+#include <windows.h>
+#include <mstcpip.h>
+#else
 #include <unistd.h>
 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <netinet/tcp.h>
 #endif
 
-#ifdef WIN32
+#ifdef WINDOWS
 static CRITICAL_SECTION lock;
 #define LOCK(lock) EnterCriticalSection(lock)
 #define UNLOCK(lock) LeaveCriticalSection(lock)
@@ -24,6 +34,7 @@ static pthread_mutex_t lock = PTHREAD_MUTEX_INITIALIZER;
 #define UNLOCK(lock) pthread_mutex_unlock(lock)
 #define SOCKET int
 #define INVALID_SOCKET (-1)
+#define WSAAPI
 #endif
 
 #if defined(__APPLE__) && defined(TCP_KEEPALIVE) /* macOS */
@@ -35,7 +46,7 @@ static pthread_mutex_t lock = PTHREAD_MUTEX_INITIALIZER;
 #elif defined(TCP_KEEPIDLE) /* Linux, etc */
 #define USE_TCP_KEEPIDLE
 #define SUPPORT_TCP_KEEPALIVE_TIME
-#elif defined(WIN32) /* Windows */
+#elif defined(WINDOWS)
 #define SUPPORT_TCP_KEEPALIVE_TIME
 #endif
 
@@ -43,7 +54,7 @@ int oci8_cancel_read_at_exit = 0;
 
 #ifdef SUPPORT_TCP_KEEPALIVE_TIME
 int oci8_tcp_keepalive_time = 0;
-static int hook_setsockopt(SOCKET sockfd, int level, int optname, const void *optval, socklen_t optlen);
+static int WSAAPI hook_setsockopt(SOCKET sockfd, int level, int optname, const void *optval, socklen_t optlen);
 #else
 int oci8_tcp_keepalive_time = -1;
 #endif
@@ -115,7 +126,7 @@ static int replace_functions(const char * const *files, hook_func_entry_t *funct
     return -1;
 }
 
-#ifdef WIN32
+#ifdef WINDOWS
 
 #ifndef _MSC_VER
 /* setsockopt() in ws2_32.dll */
@@ -288,7 +299,7 @@ static void shutdown_socket(socket_entry_t *entry)
 #endif
 
 #ifdef SUPPORT_TCP_KEEPALIVE_TIME
-static int hook_setsockopt(SOCKET sockfd, int level, int optname, const void *optval, socklen_t optlen)
+static int WSAAPI hook_setsockopt(SOCKET sockfd, int level, int optname, const void *optval, socklen_t optlen)
 {
     int rv = setsockopt(sockfd, level, optname, optval, optlen);
 
@@ -306,7 +317,7 @@ static int hook_setsockopt(SOCKET sockfd, int level, int optname, const void *op
             setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPALIVE_THRESHOLD, &millisec, sizeof(millisec));
 #elif defined(USE_TCP_KEEPIDLE) /* Linux, etc */
             setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &oci8_tcp_keepalive_time, sizeof(int));
-#elif defined(WIN32) /* Windows */
+#elif defined(WINDOWS)
             struct tcp_keepalive vals;
             DWORD dummy;
 
@@ -326,7 +337,7 @@ void oci8_shutdown_sockets(void)
 {
     socket_entry_t *entry;
 
-#ifdef WIN32
+#ifdef WINDOWS
     if (!locK_is_initialized) {
         return;
     }

data/ext/oci8/oci8lib.c

@@ -71,7 +71,7 @@ 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)
+#if defined(HAVE_PLTHOOK) && !defined(WIN32) && !defined(__CYGWIN__)
 static const char *find_libclntsh(void *handle)
 {
     void *symaddr = dlsym(handle, "OCIEnvCreate");
@@ -226,7 +226,7 @@ Init_oci8lib()
         oracle_client_version = ORAVERNUM(major, minor, update, patch, port_update);
     }
 #endif
-#if defined(HAVE_PLTHOOK) && !defined(WIN32)
+#if defined(HAVE_PLTHOOK) && !defined(WIN32) && !defined(__CYGWIN__)
     rebind_internal_symbols();
 #endif
 

data/lib/oci8/properties.rb

@@ -177,13 +177,13 @@ class OCI8
   #
   # [:tcp_keepalive]
   #
-  #     See {file:docs/hanging-after-inactivity.md.md}
+  #     See {file:docs/hanging-after-inactivity.md}
   #
   #     *Since:* 2.2.4
   #
   # [:tcp_keepalive_time]
   #
-  #     See {file:docs/hanging-after-inactivity.md.md}
+  #     See {file:docs/hanging-after-inactivity.md}
   #
   #     *Since:* 2.2.4
   #

data/lib/oci8/version.rb

@@ -1,3 +1,3 @@
 class OCI8
-  VERSION = "2.2.4"
+  VERSION = "2.2.4.1"
 end

metadata

@@ -6,7 +6,8 @@ version: !ruby/object:Gem::Version
   - 2
   - 2
   - 4
-  version: 2.2.4
+  - 1
+  version: 2.2.4.1
 platform: ruby
 authors: 
 - Kubo Takehiro
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2017-06-11 00:00:00 +09:00
+date: 2017-06-17 00:00:00 +09:00
 default_executable: 
 dependencies: []