mysql2 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a78b4022bc64300ea98eb6609cd7257900bc3245
-  data.tar.gz: e9be4bdd59bb65e1a05631e53c70359476bf2a3d
+  metadata.gz: ea76ea0b1ef19163cecb0a38f0a4bcf44b0b32c5
+  data.tar.gz: 472478d5dd515629891b26aca5169d038df0df0e
 SHA512:
-  metadata.gz: e6cd0601f7dbb44e17969a1d818049d4e3d330acce4a491f6079db61a0a8f368b855889984d8e1ab089c8beca5667e2339db7ba50f7e50d4afe92e4783dee044
-  data.tar.gz: 2d012a8b59ea34983f18871ba16176ede502b7bc9938481466112aec34a076cfeebcc7da1d0627cd854279ffacbbf38af8d9c5e56f02175371aa713553c2d45f
+  metadata.gz: de4abae3ac4f88dcedf81ab2b4d24b38b22e2006b38476b986a4fe072512d7eb7a7c1c68f569f0ee30b45ffa0e3a727ea626b392e837fcde2444a099a1cb00c5
+  data.tar.gz: 15b876980c214865b1098d4f821647f0c1fd93ab397b020214325984d1e10e36d69297739958773ae158af9ecf2aa932c408b926b18e31a1446a3d8bdfed4de1

data/examples/eventmachine.rb

@@ -18,4 +18,4 @@ EM.run do
   defer2.callback do |result|
     puts "Result: #{result.to_a.inspect}"
   end
-end
+end

data/ext/mysql2/client.c

@@ -17,8 +17,7 @@
 VALUE cMysql2Client;
 extern VALUE mMysql2, cMysql2Error;
 static VALUE sym_id, sym_version, sym_header_version, sym_async, sym_symbolize_keys, sym_as, sym_array, sym_stream;
-static ID intern_merge, intern_merge_bang, intern_error_number_eql, intern_sql_state_eql;
-static ID intern_brackets, intern_new;
+static ID intern_brackets, intern_merge, intern_merge_bang, intern_new_with_args;
 
 #ifndef HAVE_RB_HASH_DUP
 VALUE rb_hash_dup(VALUE other) {
@@ -124,11 +123,12 @@ static VALUE rb_raise_mysql2_error(mysql_client_wrapper *wrapper) {
   rb_enc_associate(rb_sql_state, rb_usascii_encoding());
 #endif
 
-  e = rb_funcall(cMysql2Error, intern_new, 2, rb_error_msg, LONG2FIX(wrapper->server_version));
-  rb_funcall(e, intern_error_number_eql, 1, UINT2NUM(mysql_errno(wrapper->client)));
-  rb_funcall(e, intern_sql_state_eql, 1, rb_sql_state);
+  e = rb_funcall(cMysql2Error, intern_new_with_args, 4,
+                 rb_error_msg,
+                 LONG2FIX(wrapper->server_version),
+                 UINT2NUM(mysql_errno(wrapper->client)),
+                 rb_sql_state);
   rb_exc_raise(e);
-  return Qnil;
 }
 
 static void *nogvl_init(void *ptr) {
@@ -209,32 +209,19 @@ static VALUE invalidate_fd(int clientfd)
 #endif /* _WIN32 */
 
 static void *nogvl_close(void *ptr) {
-  mysql_client_wrapper *wrapper;
-  wrapper = ptr;
-  if (wrapper->connected) {
-    wrapper->active_thread = Qnil;
-    wrapper->connected = 0;
-#ifndef _WIN32
-    /* Invalidate the socket before calling mysql_close(). This prevents
-     * mysql_close() from sending a mysql-QUIT or from calling shutdown() on
-     * the socket. The difference is that invalidate_fd will drop this
-     * process's reference to the socket only, while a QUIT or shutdown()
-     * would render the underlying connection unusable, interrupting other
-     * processes which share this object across a fork().
-     */
-    if (invalidate_fd(wrapper->client->net.fd) == Qfalse) {
-      fprintf(stderr, "[WARN] mysql2 failed to invalidate FD safely, leaking some memory\n");
-      close(wrapper->client->net.fd);
-      return NULL;
-    }
-#endif
+  mysql_client_wrapper *wrapper = ptr;
 
-    mysql_close(wrapper->client); /* only used to free memory at this point */
+  if (wrapper->client) {
+    mysql_close(wrapper->client);
+    wrapper->client = NULL;
+    wrapper->connected = 0;
+    wrapper->active_thread = Qnil;
   }
 
   return NULL;
 }
 
+/* this is called during GC */
 static void rb_mysql_client_free(void *ptr) {
   mysql_client_wrapper *wrapper = (mysql_client_wrapper *)ptr;
   decr_mysql2_client(wrapper);
@@ -245,6 +232,22 @@ void decr_mysql2_client(mysql_client_wrapper *wrapper)
   wrapper->refcount--;
 
   if (wrapper->refcount == 0) {
+#ifndef _WIN32
+    if (wrapper->connected) {
+      /* The client is being garbage collected while connected. Prevent
+       * mysql_close() from sending a mysql-QUIT or from calling shutdown() on
+       * the socket by invalidating it. invalidate_fd() will drop this
+       * process's reference to the socket only, while a QUIT or shutdown()
+       * would render the underlying connection unusable, interrupting other
+       * processes which share this object across a fork().
+       */
+      if (invalidate_fd(wrapper->client->net.fd) == Qfalse) {
+        fprintf(stderr, "[WARN] mysql2 failed to invalidate FD safely\n");
+        close(wrapper->client->net.fd);
+      }
+    }
+#endif
+
     nogvl_close(wrapper);
     xfree(wrapper->client);
     xfree(wrapper);
@@ -256,7 +259,7 @@ static VALUE allocate(VALUE klass) {
   mysql_client_wrapper * wrapper;
   obj = Data_Make_Struct(klass, mysql_client_wrapper, rb_mysql_client_mark, rb_mysql_client_free, wrapper);
   wrapper->encoding = Qnil;
-  wrapper->active_thread = Qnil;
+  MARK_CONN_INACTIVE(self);
   wrapper->server_version = 0;
   wrapper->reconnect_enabled = 0;
   wrapper->connect_timeout = 0;
@@ -378,10 +381,13 @@ static VALUE rb_connect(VALUE self, VALUE user, VALUE pass, VALUE host, VALUE po
 }
 
 /*
- * Immediately disconnect from the server, normally the garbage collector
- * will disconnect automatically when a connection is no longer needed.
- * Explicitly closing this will free up server resources sooner than waiting
- * for the garbage collector.
+ * Terminate the connection; call this when the connection is no longer needed.
+ * The garbage collector can close the connection, but doing so emits an
+ * "Aborted connection" error on the server and increments the Aborted_clients
+ * status variable.
+ *
+ * @see http://dev.mysql.com/doc/en/communication-errors.html
+ * @return [void]
  */
 static VALUE rb_mysql_client_close(VALUE self) {
   GET_CLIENT(self);
@@ -412,7 +418,7 @@ static VALUE do_send_query(void *args) {
   mysql_client_wrapper *wrapper = query_args->wrapper;
   if ((VALUE)rb_thread_call_without_gvl(nogvl_send_query, args, RUBY_UBF_IO, 0) == Qfalse) {
     /* an error occurred, we're not active anymore */
-    wrapper->active_thread = Qnil;
+    MARK_CONN_INACTIVE(self);
     return rb_raise_mysql2_error(wrapper);
   }
   return Qnil;
@@ -443,7 +449,7 @@ static void *nogvl_do_result(void *ptr, char use_result) {
 
   /* once our result is stored off, this connection is
      ready for another command to be issued */
-  wrapper->active_thread = Qnil;
+  MARK_CONN_INACTIVE(self);
 
   return result;
 }
@@ -512,7 +518,7 @@ struct async_query_args {
 static VALUE disconnect_and_raise(VALUE self, VALUE error) {
   GET_CLIENT(self);
 
-  wrapper->active_thread = Qnil;
+  MARK_CONN_INACTIVE(self);
   wrapper->connected = 0;
 
   /* Invalidate the MySQL socket to prevent further communication.
@@ -524,8 +530,6 @@ static VALUE disconnect_and_raise(VALUE self, VALUE error) {
   }
 
   rb_exc_raise(error);
-
-  return Qnil;
 }
 
 static VALUE do_query(void *args) {
@@ -588,7 +592,7 @@ static VALUE finish_and_mark_inactive(void *args) {
     result = (MYSQL_RES *)rb_thread_call_without_gvl(nogvl_store_result, wrapper, RUBY_UBF_IO, 0);
     mysql_free_result(result);
 
-    wrapper->active_thread = Qnil;
+    MARK_CONN_INACTIVE(self);
   }
 
   return Qnil;
@@ -610,7 +614,6 @@ void rb_mysql_client_set_active_thread(VALUE self) {
     const char *thr = StringValueCStr(inspect);
 
     rb_raise(cMysql2Error, "This connection is in use by: %s", thr);
-    (void)RB_GC_GUARD(inspect);
   }
 }
 
@@ -648,7 +651,7 @@ static VALUE rb_mysql_client_abandon_results(VALUE self) {
  *    client.query(sql, options = {})
  *
  * Query the database with +sql+, with optional +options+.  For the possible
- * options, see @@default_query_options on the Mysql2::Client class.
+ * options, see default_query_options on the Mysql2::Client class.
  */
 static VALUE rb_query(VALUE self, VALUE sql, VALUE current) {
 #ifndef _WIN32
@@ -1215,6 +1218,7 @@ static VALUE rb_mysql_client_prepare_statement(VALUE self, VALUE sql) {
 }
 
 void init_mysql2_client() {
+#ifdef _WIN32
   /* verify the libmysql we're about to use was the version we were built against
      https://github.com/luislavena/mysql-gem/commit/a600a9c459597da0712f70f43736e24b484f8a99 */
   int i;
@@ -1229,15 +1233,14 @@ void init_mysql2_client() {
     }
     if (lib[i] != MYSQL_LINK_VERSION[i]) {
       rb_raise(rb_eRuntimeError, "Incorrect MySQL client library version! This gem was compiled for %s but the client library is %s.", MYSQL_LINK_VERSION, lib);
-      return;
     }
   }
+#endif
 
   /* Initializing mysql library, so different threads could call Client.new */
   /* without race condition in the library */
   if (mysql_library_init(0, NULL, NULL) != 0) {
     rb_raise(rb_eRuntimeError, "Could not initialize MySQL client library");
-    return;
   }
 
 #if 0
@@ -1296,11 +1299,9 @@ void init_mysql2_client() {
   sym_stream          = ID2SYM(rb_intern("stream"));
 
   intern_brackets = rb_intern("[]");
-  intern_new = rb_intern("new");
   intern_merge = rb_intern("merge");
   intern_merge_bang = rb_intern("merge!");
-  intern_error_number_eql = rb_intern("error_number=");
-  intern_sql_state_eql = rb_intern("sql_state=");
+  intern_new_with_args = rb_intern("new_with_args");
 
 #ifdef CLIENT_LONG_PASSWORD
   rb_const_set(cMysql2Client, rb_intern("LONG_PASSWORD"),

data/ext/mysql2/client.h

@@ -59,7 +59,6 @@ typedef struct {
 void rb_mysql_client_set_active_thread(VALUE self);
 
 #define MARK_CONN_INACTIVE(conn) do {\
-    GET_CLIENT(conn); \
     wrapper->active_thread = Qnil; \
   } while(0)
 
@@ -67,7 +66,7 @@ void rb_mysql_client_set_active_thread(VALUE self);
   mysql_client_wrapper *wrapper; \
   Data_Get_Struct(self, mysql_client_wrapper, wrapper);
 
-void init_mysql2_client();
+void init_mysql2_client(void);
 void decr_mysql2_client(mysql_client_wrapper *wrapper);
 
 #endif

data/ext/mysql2/extconf.rb

@@ -1,7 +1,8 @@
 # encoding: UTF-8
 require 'mkmf'
+require 'English'
 
-def asplode lib
+def asplode(lib)
   if RUBY_PLATFORM =~ /mingw|mswin/
     abort "-----\n#{lib} is missing. Check your installation of MySQL or Connector/C, and try again.\n-----"
   elsif RUBY_PLATFORM =~ /darwin/
@@ -22,7 +23,7 @@ have_func('rb_intern3')
 
 # borrowed from mysqlplus
 # http://github.com/oldmoe/mysqlplus/blob/master/ext/extconf.rb
-dirs = ENV['PATH'].split(File::PATH_SEPARATOR) + %w[
+dirs = ENV.fetch('PATH').split(File::PATH_SEPARATOR) + %w(
   /opt
   /opt/local
   /opt/local/mysql
@@ -34,13 +35,14 @@ dirs = ENV['PATH'].split(File::PATH_SEPARATOR) + %w[
   /usr/local/mysql-*
   /usr/local/lib/mysql5*
   /usr/local/opt/mysql5*
-].map{|dir| "#{dir}/bin" }
+).map { |dir| dir << '/bin' }
 
 GLOB = "{#{dirs.join(',')}}/{mysql_config,mysql_config5,mariadb_config}"
 
 # If the user has provided a --with-mysql-dir argument, we must respect it or fail.
 inc, lib = dir_config('mysql')
 if inc && lib
+  # TODO: Remove when 2.0.0 is the minimum supported version
   # Ruby versions not incorporating the mkmf fix at
   # https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/39717
   # do not properly search for lib directories, and must be corrected
@@ -48,35 +50,33 @@ if inc && lib
     @libdir_basename = 'lib'
     inc, lib = dir_config('mysql')
   end
-  abort "-----\nCannot find include dir(s) #{inc}\n-----" unless inc && inc.split(File::PATH_SEPARATOR).any?{|dir| File.directory?(dir)}
-  abort "-----\nCannot find library dir(s) #{lib}\n-----" unless lib && lib.split(File::PATH_SEPARATOR).any?{|dir| File.directory?(dir)}
-  warn  "-----\nUsing --with-mysql-dir=#{File.dirname inc}\n-----"
+  abort "-----\nCannot find include dir(s) #{inc}\n-----" unless inc && inc.split(File::PATH_SEPARATOR).any? { |dir| File.directory?(dir) }
+  abort "-----\nCannot find library dir(s) #{lib}\n-----" unless lib && lib.split(File::PATH_SEPARATOR).any? { |dir| File.directory?(dir) }
+  warn "-----\nUsing --with-mysql-dir=#{File.dirname inc}\n-----"
   rpath_dir = lib
-elsif mc = (with_config('mysql-config') || Dir[GLOB].first)
+elsif (mc = (with_config('mysql-config') || Dir[GLOB].first))
   # If the user has provided a --with-mysql-config argument, we must respect it or fail.
   # If the user gave --with-mysql-config with no argument means we should try to find it.
   mc = Dir[GLOB].first if mc == true
-  abort "-----\nCannot find mysql_config at #{mc}\n-----" unless mc && File.exists?(mc)
+  abort "-----\nCannot find mysql_config at #{mc}\n-----" unless mc && File.exist?(mc)
   abort "-----\nCannot execute mysql_config at #{mc}\n-----" unless File.executable?(mc)
-  warn  "-----\nUsing mysql_config at #{mc}\n-----"
+  warn "-----\nUsing mysql_config at #{mc}\n-----"
   ver = `#{mc} --version`.chomp.to_f
   includes = `#{mc} --include`.chomp
-  exit 1 if $? != 0
+  abort unless $CHILD_STATUS.success?
   libs = `#{mc} --libs_r`.chomp
   # MySQL 5.5 and above already have re-entrant code in libmysqlclient (no _r).
-  if ver >= 5.5 || libs.empty?
-    libs = `#{mc} --libs`.chomp
-  end
-  exit 1 if $? != 0
+  libs = `#{mc} --libs`.chomp if ver >= 5.5 || libs.empty?
+  abort unless $CHILD_STATUS.success?
   $INCFLAGS += ' ' + includes
   $libs = libs + " " + $libs
   rpath_dir = libs
 else
-  inc, lib = dir_config('mysql', '/usr/local')
+  _, usr_local_lib = dir_config('mysql', '/usr/local')
 
-  asplode("mysql client") unless find_library('mysqlclient', 'mysql_query', lib, "#{lib}/mysql")
+  asplode("mysql client") unless find_library('mysqlclient', 'mysql_query', usr_local_lib, "#{usr_local_lib}/mysql")
 
-  rpath_dir = lib
+  rpath_dir = usr_local_lib
 end
 
 if have_header('mysql.h')
@@ -87,27 +87,49 @@ else
   asplode 'mysql.h'
 end
 
-%w{ errmsg.h mysqld_error.h }.each do |h|
+%w(errmsg.h mysqld_error.h).each do |h|
   header = [prefix, h].compact.join '/'
-  asplode h unless have_header h
+  asplode h unless have_header header
 end
 
 # This is our wishlist. We use whichever flags work on the host.
-# TODO: fix statement.c and remove -Wno-declaration-after-statement
-# TODO: fix gperf mysql_enc_name_to_ruby.h and remove -Wno-missing-field-initializers
-%w(
-  -Wall
-  -Wextra
-  -Werror
-  -Wno-unused-function
-  -Wno-declaration-after-statement
-  -Wno-missing-field-initializers
-).select do |flag|
+# -Wall and -Wextra are included by default.
+wishlist = [
+  '-Weverything',
+  '-Wno-bad-function-cast', # rb_thread_call_without_gvl returns void * that we cast to VALUE
+  '-Wno-conditional-uninitialized', # false positive in client.c
+  '-Wno-covered-switch-default', # result.c -- enum_field_types (when fully covered, e.g. mysql 5.5)
+  '-Wno-declaration-after-statement', # GET_CLIENT followed by GET_STATEMENT in statement.c
+  '-Wno-disabled-macro-expansion', # rubby :(
+  '-Wno-documentation-unknown-command', # rubby :(
+  '-Wno-missing-field-initializers', # gperf generates bad code
+  '-Wno-missing-variable-declarations', # missing symbols due to ruby native ext initialization
+  '-Wno-padded', # mysql :(
+  '-Wno-sign-conversion', # gperf generates bad code
+  '-Wno-static-in-inline', # gperf generates bad code
+  '-Wno-switch-enum', # result.c -- enum_field_types (when not fully covered, e.g. mysql 5.6+)
+  '-Wno-undef', # rubinius :(
+  '-Wno-used-but-marked-unused', # rubby :(
+]
+
+if ENV['CI']
+  wishlist += [
+    '-Werror',
+    '-fsanitize=address',
+    '-fsanitize=cfi',
+    '-fsanitize=integer',
+    '-fsanitize=memory',
+    '-fsanitize=thread',
+    '-fsanitize=undefined',
+  ]
+end
+
+usable_flags = wishlist.select do |flag|
   try_link('int main() {return 0;}', flag)
-end.each do |flag|
-  $CFLAGS << ' ' << flag
 end
 
+$CFLAGS << ' ' << usable_flags.join(' ')
+
 if RUBY_PLATFORM =~ /mswin|mingw/
   # Build libmysql.a interface link library
   require 'rake'
@@ -116,15 +138,15 @@ if RUBY_PLATFORM =~ /mswin|mingw/
   # Use rake to rebuild only if these files change
   deffile = File.expand_path('../../../support/libmysql.def', __FILE__)
   libfile = File.expand_path(File.join(rpath_dir, 'libmysql.lib'))
-  file 'libmysql.a' => [deffile, libfile] do |t|
+  file 'libmysql.a' => [deffile, libfile] do
     when_writing 'building libmysql.a' do
       # Ruby kindly shows us where dllwrap is, but that tool does more than we want.
       # Maybe in the future Ruby could provide RbConfig::CONFIG['DLLTOOL'] directly.
       dlltool = RbConfig::CONFIG['DLLWRAP'].gsub('dllwrap', 'dlltool')
       sh dlltool, '--kill-at',
-        '--dllname', 'libmysql.dll',
-        '--output-lib', 'libmysql.a',
-        '--input-def', deffile, libfile
+         '--dllname', 'libmysql.dll',
+         '--output-lib', 'libmysql.a',
+         '--input-def', deffile, libfile
     end
   end
 
@@ -143,7 +165,7 @@ if RUBY_PLATFORM =~ /mswin|mingw/
 
   vendordll = File.join(vendordir, 'libmysql.dll')
   dllfile = File.expand_path(File.join(rpath_dir, 'libmysql.dll'))
-  file vendordll => [dllfile, vendordir] do |t|
+  file vendordll => [dllfile, vendordir] do
     when_writing 'copying libmysql.dll' do
       cp dllfile, vendordll
     end
@@ -169,7 +191,7 @@ else
     warn "-----\nSetting mysql rpath to #{explicit_rpath}\n-----"
     $LDFLAGS << rpath_flags
   else
-    if libdir = rpath_dir[%r{(-L)?(/[^ ]+)}, 2]
+    if (libdir = rpath_dir[%r{(-L)?(/[^ ]+)}, 2])
       rpath_flags = " -Wl,-rpath,#{libdir}"
       if RbConfig::CONFIG["RPATHFLAG"].to_s.empty? && try_link('int main() {return 0;}', rpath_flags)
         # Usually Ruby sets RPATHFLAG the right way for each system, but not on OS X.

data/ext/mysql2/infile.c

@@ -56,7 +56,7 @@ mysql2_local_infile_init(void **ptr, const char *filename, void *userdata)
  * < 0   error
  */
 static int
-mysql2_local_infile_read(void *ptr, char *buf, uint buf_len)
+mysql2_local_infile_read(void *ptr, char *buf, unsigned int buf_len)
 {
   int count;
   mysql2_local_infile_data *data = (mysql2_local_infile_data *)ptr;
@@ -95,7 +95,7 @@ mysql2_local_infile_end(void *ptr)
  * Error message number (see http://dev.mysql.com/doc/refman/5.0/en/error-messages-client.html)
  */
 static int
-mysql2_local_infile_error(void *ptr, char *error_msg, uint error_msg_len)
+mysql2_local_infile_error(void *ptr, char *error_msg, unsigned int error_msg_len)
 {
   mysql2_local_infile_data *data = (mysql2_local_infile_data *) ptr;
 

data/ext/mysql2/mysql2_ext.h

@@ -1,18 +1,14 @@
 #ifndef MYSQL2_EXT
 #define MYSQL2_EXT
 
+void Init_mysql2(void);
+
 /* tell rbx not to use it's caching compat layer
    by doing this we're making a promise to RBX that
    we'll never modify the pointers we get back from RSTRING_PTR */
 #define RSTRING_NOT_MODIFIED
 #include <ruby.h>
 
-#ifndef HAVE_UINT
-#define HAVE_UINT
-typedef unsigned short    ushort;
-typedef unsigned int    uint;
-#endif
-
 #ifdef HAVE_MYSQL_H
 #include <mysql.h>
 #include <mysql_com.h>
@@ -33,8 +29,10 @@ typedef unsigned int    uint;
 #endif
 
 #if defined(__GNUC__) && (__GNUC__ >= 3)
+#define RB_MYSQL_NORETURN __attribute__ ((noreturn))
 #define RB_MYSQL_UNUSED __attribute__ ((unused))
 #else
+#define RB_MYSQL_NORETURN
 #define RB_MYSQL_UNUSED
 #endif