sqlite3 2.1.0.rc1-x86_64-linux-musl → 2.1.0.rc2-x86_64-linux-musl

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e80445cb812afd790310ae44ffedf1fd0ba59d351a5318b73a9686fcfa18b42
-  data.tar.gz: 51a3c2410ded1ab3fb02c6cb29facf53460f90aac13c3990ae1f653f2a0652b8
+  metadata.gz: 41b6c5ca5fd65167d1631992e4d4290b4f6a8335e661bd1b6db2ff6d438b73c9
+  data.tar.gz: b91aa02992536b221ab6d415075c4d55db295ca9fb3b2fff14c1b55c966863f7
 SHA512:
-  metadata.gz: 731a9d2f61c63b89eac5e0c63507c0a7a482eb5943e3f5e7a96147c0a475a26f9e5904f606f6565810fe17e5b7d6a9d6a63afea41cd32d02db6f8573fd8ba459
-  data.tar.gz: 13ff9eb60ea3d126c7e04d93767057bbbac460fe7de3d7f77ad08582ef2a7982c5b20e1f351732b55115c6f211c3a16c60a3bc10b9016627aa7dc931d88965b1
+  metadata.gz: 00bea5e078d188a8829140822a74fbfeb6a531ebc85b122311fceb97803ae2ad0e0cf7ab30092f55d1f4296bc45551b18de55ec5194280d1b77ede861bc5362f
+  data.tar.gz: 664cdcf8ac70f883cd71bba3d0334405cfb64330af1ecdf96c88e56bc6aebd4d29c7452c159202d43a71455819c3d4788364094d325ffa423900a0d6826c3b98

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # sqlite3-ruby Changelog
 
+## prerelease 2.1.0.rc2 / 2024-09-18
+
+### Improved
+
+- Address a performance regression in 2.1.0.rc1.
+
+
 ## prerelease 2.1.0.rc1 / 2024-09-18
 
 ### Ruby

data/CONTRIBUTING.md

@@ -16,20 +16,15 @@ please look there for additional information.
 
 All statements keep pointers back to their respective database connections.
 The `@connection` instance variable on the `Statement` handle keeps the database
-connection alive.  Memory allocated for a statement handler will be freed in
-two cases:
+connection alive.
 
-1. `#close` is called on the statement
-2. The `SQLite3::Database` object gets garbage collected
-
-We can't free the memory for the statement in the garbage collection function
-for the statement handler.  The reason is because there exists a race
-condition.  We cannot guarantee the order in which objects will be garbage
-collected.  So, it is possible that a connection and a statement are up for
-garbage collection.  If the database connection were to be free'd before the
-statement, then boom.  Instead we'll be conservative and free unclosed
-statements when the connection is terminated.
+We use `sqlite3_close_v2` in `Database#close` since v2.1.0 which defers _actually_ closing the
+connection and freeing the underlying memory until all open statments are closed; though the
+`Database` object will immediately behave as though it's been fully closed. If a Database is not
+explicitly closed, it will be closed when it is GCed.
 
+`Statement#close` finalizes the underlying statement. If a Statement is not explicitly closed, it
+will be closed/finalized when it is GCed.
 
 
 ## Building gems

data/ext/sqlite3/database.c

@@ -49,15 +49,16 @@ discard_db(sqlite3RubyPtr ctx)
     }
 
     ctx->db = NULL;
+    ctx->flags |= SQLITE3_RB_DATABASE_DISCARDED;
 }
 
 static void
 close_or_discard_db(sqlite3RubyPtr ctx)
 {
     if (ctx->db) {
-        int isReadonly = (ctx->flags & SQLITE_OPEN_READONLY);
+        int is_readonly = (ctx->flags & SQLITE3_RB_DATABASE_READONLY);
 
-        if (isReadonly || ctx->owner == getpid()) {
+        if (is_readonly || ctx->owner == getpid()) {
             // Ordinary close.
             sqlite3_close_v2(ctx->db);
             ctx->db = NULL;
@@ -153,7 +154,9 @@ rb_sqlite3_open_v2(VALUE self, VALUE file, VALUE mode, VALUE zvfs)
              );
 
     CHECK(ctx->db, status);
-    ctx->flags = flags;
+    if (flags & SQLITE_OPEN_READONLY) {
+        ctx->flags |= SQLITE3_RB_DATABASE_READONLY;
+    }
 
     return self;
 }
@@ -943,11 +946,10 @@ rb_sqlite3_open16(VALUE self, VALUE file)
 #endif
 #endif
 
-    status = sqlite3_open16(utf16_string_value_ptr(file), &ctx->db);
-
-    // these are the perm flags used implicitly by sqlite3_open16,
+    // sqlite3_open16 implicitly uses flags (SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE)
     // see https://www.sqlite.org/capi3ref.html#sqlite3_open
-    ctx->flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE;
+    // so we do not ever set SQLITE3_RB_DATABASE_READONLY in ctx->flags
+    status = sqlite3_open16(utf16_string_value_ptr(file), &ctx->db);
 
     CHECK(ctx->db, status)
 

data/ext/sqlite3/database.h

@@ -3,6 +3,10 @@
 
 #include <sqlite3_ruby.h>
 
+/* bits in the `flags` field */
+#define SQLITE3_RB_DATABASE_READONLY  0x01
+#define SQLITE3_RB_DATABASE_DISCARDED 0x02
+
 struct _sqlite3Ruby {
     sqlite3 *db;
     VALUE busy_handler;

data/ext/sqlite3/statement.c

@@ -1,22 +1,12 @@
 #include <sqlite3_ruby.h>
 
 #define REQUIRE_OPEN_STMT(_ctxt) \
-  if(!_ctxt->st) \
+  if (!_ctxt->st) \
     rb_raise(rb_path2class("SQLite3::Exception"), "cannot use a closed statement");
 
-static void
-require_open_db(VALUE stmt_rb)
-{
-    VALUE closed_p = rb_funcall(
-                         rb_iv_get(stmt_rb, "@connection"),
-                         rb_intern("closed?"), 0);
-
-    if (RTEST(closed_p)) {
-        rb_raise(rb_path2class("SQLite3::Exception"),
-                 "cannot use a statement associated with a closed database");
-    }
-}
-
+#define REQUIRE_LIVE_DB(_ctxt) \
+  if (_ctxt->db->flags & SQLITE3_RB_DATABASE_DISCARDED) \
+    rb_raise(rb_path2class("SQLite3::Exception"), "cannot use a statement associated with a discarded database");
 
 VALUE cSqlite3Statement;
 
@@ -71,6 +61,11 @@ prepare(VALUE self, VALUE db, VALUE sql)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
+    /* Dereferencing a pointer to the database struct will be faster than accessing it through the
+     * instance variable @connection. The struct pointer is guaranteed to be live because instance
+     * variable will keep it from being GCed. */
+    ctx->db = db_ctx;
+
 #ifdef HAVE_SQLITE3_PREPARE_V2
     status = sqlite3_prepare_v2(
 #else
@@ -135,7 +130,7 @@ step(VALUE self)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     if (ctx->done_p) { return Qnil; }
@@ -232,7 +227,7 @@ bind_param(VALUE self, VALUE key, VALUE value)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     switch (TYPE(key)) {
@@ -326,7 +321,7 @@ reset_bang(VALUE self)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     sqlite3_reset(ctx->st);
@@ -348,7 +343,7 @@ clear_bindings_bang(VALUE self)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     sqlite3_clear_bindings(ctx->st);
@@ -382,7 +377,7 @@ column_count(VALUE self)
     sqlite3StmtRubyPtr ctx;
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     return INT2NUM(sqlite3_column_count(ctx->st));
@@ -415,7 +410,7 @@ column_name(VALUE self, VALUE index)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     name = sqlite3_column_name(ctx->st, (int)NUM2INT(index));
@@ -440,7 +435,7 @@ column_decltype(VALUE self, VALUE index)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     name = sqlite3_column_decltype(ctx->st, (int)NUM2INT(index));
@@ -459,7 +454,7 @@ bind_parameter_count(VALUE self)
     sqlite3StmtRubyPtr ctx;
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     return INT2NUM(sqlite3_bind_parameter_count(ctx->st));
@@ -568,7 +563,7 @@ stats_as_hash(VALUE self)
     sqlite3StmtRubyPtr ctx;
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     VALUE arg = rb_hash_new();
@@ -587,7 +582,7 @@ stat_for(VALUE self, VALUE key)
     sqlite3StmtRubyPtr ctx;
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     if (SYMBOL_P(key)) {
@@ -609,7 +604,7 @@ memused(VALUE self)
     sqlite3StmtRubyPtr ctx;
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     return INT2NUM(sqlite3_stmt_status(ctx->st, SQLITE_STMTSTATUS_MEMUSED, 0));
@@ -628,7 +623,7 @@ database_name(VALUE self, VALUE index)
     sqlite3StmtRubyPtr ctx;
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     return SQLITE3_UTF8_STR_NEW2(
@@ -647,7 +642,7 @@ get_sql(VALUE self)
     sqlite3StmtRubyPtr ctx;
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     return rb_obj_freeze(SQLITE3_UTF8_STR_NEW2(sqlite3_sql(ctx->st)));
@@ -667,7 +662,7 @@ get_expanded_sql(VALUE self)
 
     TypedData_Get_Struct(self, sqlite3StmtRuby, &statement_type, ctx);
 
-    require_open_db(self);
+    REQUIRE_LIVE_DB(ctx);
     REQUIRE_OPEN_STMT(ctx);
 
     expanded_sql = sqlite3_expanded_sql(ctx->st);

data/ext/sqlite3/statement.h

@@ -5,6 +5,7 @@
 
 struct _sqlite3StmtRuby {
     sqlite3_stmt *st;
+    sqlite3Ruby *db;
     int done_p;
 };
 

data/lib/sqlite3/version.rb

@@ -1,3 +1,3 @@
 module SQLite3
-  VERSION = "2.1.0.rc1"
+  VERSION = "2.1.0.rc2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqlite3
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc1
+  version: 2.1.0.rc2
 platform: x86_64-linux-musl
 authors:
 - Jamis Buck
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies: []
 description: |
   Ruby library to interface with the SQLite3 database engine (http://www.sqlite.org). Precompiled