aim-sqlite3 2.9.6.1.rc1

data/ext/sqlite3/database.h

@@ -0,0 +1,36 @@
+#ifndef SQLITE3_DATABASE_RUBY
+#define SQLITE3_DATABASE_RUBY
+
+#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;
+    VALUE functions;
+    VALUE collations;
+    VALUE aggregators;
+    VALUE trace_handler;
+    VALUE authorizer;
+    int stmt_timeout;
+    struct timespec stmt_deadline;
+    rb_pid_t owner;
+    int flags;
+};
+
+typedef struct _sqlite3Ruby sqlite3Ruby;
+typedef sqlite3Ruby *sqlite3RubyPtr;
+
+/* Pinning a collection doesn't pin what's in it, hence both. */
+void rb_sqlite3_pin_array_and_contents(VALUE ary);
+
+void init_sqlite3_database();
+void set_sqlite3_func_result(sqlite3_context *ctx, VALUE result);
+
+sqlite3RubyPtr sqlite3_database_unwrap(VALUE database);
+VALUE sqlite3val2rb(sqlite3_value *val);
+
+#endif

data/ext/sqlite3/exception.c

@@ -0,0 +1,122 @@
+#include <sqlite3_ruby.h>
+
+static VALUE
+status2klass(int status)
+{
+    /* Consider only lower 8 bits, to work correctly when
+       extended result codes are enabled. */
+    switch (status & 0xff) {
+        case SQLITE_OK:
+            return Qnil;
+        case SQLITE_ERROR:
+            return rb_path2class("SQLite3::SQLException");
+        case SQLITE_INTERNAL:
+            return rb_path2class("SQLite3::InternalException");
+        case SQLITE_PERM:
+            return rb_path2class("SQLite3::PermissionException");
+        case SQLITE_ABORT:
+            return rb_path2class("SQLite3::AbortException");
+        case SQLITE_BUSY:
+            return rb_path2class("SQLite3::BusyException");
+        case SQLITE_LOCKED:
+            return rb_path2class("SQLite3::LockedException");
+        case SQLITE_NOMEM:
+            return rb_path2class("SQLite3::MemoryException");
+        case SQLITE_READONLY:
+            return rb_path2class("SQLite3::ReadOnlyException");
+        case SQLITE_INTERRUPT:
+            return rb_path2class("SQLite3::InterruptException");
+        case SQLITE_IOERR:
+            return rb_path2class("SQLite3::IOException");
+        case SQLITE_CORRUPT:
+            return rb_path2class("SQLite3::CorruptException");
+        case SQLITE_NOTFOUND:
+            return rb_path2class("SQLite3::NotFoundException");
+        case SQLITE_FULL:
+            return rb_path2class("SQLite3::FullException");
+        case SQLITE_CANTOPEN:
+            return rb_path2class("SQLite3::CantOpenException");
+        case SQLITE_PROTOCOL:
+            return rb_path2class("SQLite3::ProtocolException");
+        case SQLITE_EMPTY:
+            return rb_path2class("SQLite3::EmptyException");
+        case SQLITE_SCHEMA:
+            return rb_path2class("SQLite3::SchemaChangedException");
+        case SQLITE_TOOBIG:
+            return rb_path2class("SQLite3::TooBigException");
+        case SQLITE_CONSTRAINT:
+            return rb_path2class("SQLite3::ConstraintException");
+        case SQLITE_MISMATCH:
+            return rb_path2class("SQLite3::MismatchException");
+        case SQLITE_MISUSE:
+            return rb_path2class("SQLite3::MisuseException");
+        case SQLITE_NOLFS:
+            return rb_path2class("SQLite3::UnsupportedException");
+        case SQLITE_AUTH:
+            return rb_path2class("SQLite3::AuthorizationException");
+        case SQLITE_FORMAT:
+            return rb_path2class("SQLite3::FormatException");
+        case SQLITE_RANGE:
+            return rb_path2class("SQLite3::RangeException");
+        case SQLITE_NOTADB:
+            return rb_path2class("SQLite3::NotADatabaseException");
+        default:
+            return rb_path2class("SQLite3::Exception");
+    }
+}
+
+void
+rb_sqlite3_raise(sqlite3 *db, int status)
+{
+    VALUE klass = status2klass(status);
+    if (NIL_P(klass)) {
+        return;
+    }
+
+    VALUE exception = rb_exc_new2(klass, sqlite3_errmsg(db));
+    rb_iv_set(exception, "@code", INT2FIX(status));
+
+    rb_exc_raise(exception);
+}
+
+/*
+ *  accepts a sqlite3 error message as the final argument, which will be `sqlite3_free`d
+ */
+void
+rb_sqlite3_raise_msg(sqlite3 *db, int status, const char *msg)
+{
+    VALUE klass = status2klass(status);
+    if (NIL_P(klass)) {
+        return;
+    }
+
+    VALUE exception = rb_exc_new2(klass, msg);
+    rb_iv_set(exception, "@code", INT2FIX(status));
+    sqlite3_free((void *)msg);
+
+    rb_exc_raise(exception);
+}
+
+void
+rb_sqlite3_raise_with_sql(sqlite3 *db, int status, const char *sql)
+{
+    VALUE klass = status2klass(status);
+    if (NIL_P(klass)) {
+        return;
+    }
+
+    const char *error_msg = sqlite3_errmsg(db);
+    int error_offset = -1;
+#ifdef HAVE_SQLITE3_ERROR_OFFSET
+    error_offset = sqlite3_error_offset(db);
+#endif
+
+    VALUE exception = rb_exc_new2(klass, error_msg);
+    rb_iv_set(exception, "@code", INT2FIX(status));
+    if (sql) {
+        rb_iv_set(exception, "@sql", rb_str_new2(sql));
+        rb_iv_set(exception, "@sql_offset", INT2FIX(error_offset));
+    }
+
+    rb_exc_raise(exception);
+}

data/ext/sqlite3/exception.h

@@ -0,0 +1,12 @@
+#ifndef SQLITE3_EXCEPTION_RUBY
+#define SQLITE3_EXCEPTION_RUBY
+
+#define CHECK(_db, _status) rb_sqlite3_raise(_db, _status);
+#define CHECK_MSG(_db, _status, _msg) rb_sqlite3_raise_msg(_db, _status, _msg);
+#define CHECK_PREPARE(_db, _status, _sql) rb_sqlite3_raise_with_sql(_db, _status, _sql)
+
+void rb_sqlite3_raise(sqlite3 *db, int status);
+void rb_sqlite3_raise_msg(sqlite3 *db, int status, const char *msg);
+void rb_sqlite3_raise_with_sql(sqlite3 *db, int status, const char *sql);
+
+#endif

data/ext/sqlite3/extconf.rb

@@ -0,0 +1,299 @@
+require "mkmf"
+require "yaml"
+
+module Sqlite3
+  module ExtConf
+    ENV_ALLOWLIST = ["CC", "CFLAGS", "LDFLAGS", "LIBS", "CPPFLAGS", "LT_SYS_LIBRARY_PATH", "CPP"]
+
+    class << self
+      def configure
+        configure_cross_compiler
+
+        if system_libraries?
+          message "Building sqlite3-ruby using system #{libname}.\n"
+          configure_system_libraries
+        else
+          message "Building sqlite3-ruby using packaged sqlite3.\n"
+          configure_packaged_libraries
+        end
+
+        configure_extension
+
+        create_makefile("sqlite3/sqlite3_native")
+      end
+
+      def configure_cross_compiler
+        RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
+        ENV["CC"] = RbConfig::CONFIG["CC"]
+      end
+
+      def system_libraries?
+        sqlcipher? || enable_config("system-libraries")
+      end
+
+      def libname
+        sqlcipher? ? "sqlcipher" : "sqlite3"
+      end
+
+      def sqlcipher?
+        with_config("sqlcipher") ||
+          with_config("sqlcipher-dir") ||
+          with_config("sqlcipher-include") ||
+          with_config("sqlcipher-lib")
+      end
+
+      def configure_system_libraries
+        pkg_config(libname)
+        append_cppflags("-DUSING_SQLCIPHER") if sqlcipher?
+      end
+
+      def configure_packaged_libraries
+        minimal_recipe.tap do |recipe|
+          recipe.configure_options += [
+            "--disable-shared",
+            "--enable-static",
+            "--enable-fts5",
+            "--disable-readline" # keeps the sqlite3 program portable
+          ]
+          ENV.to_h.tap do |env|
+            user_cflags = with_config("sqlite-cflags")
+            more_cflags = [
+              "-fPIC", # needed for linking the static library into a shared library
+              "-O2", # see https://github.com/sparklemotion/sqlite3-ruby/issues/335 for some benchmarks
+              "-fvisibility=hidden", # see https://github.com/rake-compiler/rake-compiler-dock/issues/87
+              "-DSQLITE_DEFAULT_WAL_SYNCHRONOUS=1",
+              "-DSQLITE_USE_URI=1",
+              "-DSQLITE_ENABLE_DBPAGE_VTAB=1",
+              "-DSQLITE_ENABLE_DBSTAT_VTAB=1",
+              "-DSQLITE_MAX_ATTACHED=50"
+            ]
+            env["CFLAGS"] = [user_cflags, env["CFLAGS"], more_cflags].flatten.join(" ")
+            recipe.configure_options += env.slice(*ENV_ALLOWLIST)
+              .map { |key, value| "#{key}=#{value.strip}" }
+          end
+
+          unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
+            recipe.cook
+          end
+          recipe.activate
+
+          # on macos, pkg-config will not return --cflags without this
+          ENV["PKG_CONFIG_ALLOW_SYSTEM_CFLAGS"] = "t"
+
+          # only needed for Ruby 3.1.3, see https://bugs.ruby-lang.org/issues/19233
+          RbConfig::CONFIG["PKG_CONFIG"] = config_string("PKG_CONFIG") || "pkg-config"
+
+          lib_path = File.join(recipe.path, "lib")
+          pcfile = File.join(lib_path, "pkgconfig", "sqlite3.pc")
+          abort_pkg_config("pkg_config") unless pkg_config(pcfile)
+
+          # see https://bugs.ruby-lang.org/issues/18490
+          ldflags = xpopen(["pkg-config", "--libs", "--static", pcfile], err: [:child, :out], &:read)
+          abort_pkg_config("xpopen") unless $?.success?
+          ldflags = ldflags.split
+
+          # see https://github.com/flavorjones/mini_portile/issues/118
+          "-L#{lib_path}".tap do |lib_path_flag|
+            ldflags.prepend(lib_path_flag) unless ldflags.include?(lib_path_flag)
+          end
+
+          ldflags.each { |ldflag| append_ldflags(ldflag) }
+
+          append_cppflags("-DUSING_PACKAGED_LIBRARIES")
+          append_cppflags("-DUSING_PRECOMPILED_LIBRARIES") if cross_build?
+        end
+      end
+
+      def configure_extension
+        append_cflags("-fvisibility=hidden") # see https://github.com/rake-compiler/rake-compiler-dock/issues/87
+
+        if sqlcipher? && find_header("sqlcipher/sqlite3.h")
+          append_cppflags("-DUSING_SQLCIPHER_INC_SUBDIR")
+        elsif find_header("sqlite3.h")
+          # noop
+        else
+          abort_could_not_find("sqlite3.h")
+        end
+
+        abort_could_not_find(libname) unless find_library(libname, "sqlite3_libversion_number", "sqlite3.h")
+
+        # Truffle Ruby doesn't support this yet:
+        # https://github.com/oracle/truffleruby/issues/3408
+        have_func("rb_enc_interned_str_cstr")
+
+        # Functions defined in 1.9 but not 1.8
+        have_func("rb_proc_arity")
+
+        # Functions defined in 2.1 but not 2.0
+        have_func("rb_integer_pack")
+
+        # These functions may not be defined
+        have_func("sqlite3_initialize")
+        have_func("sqlite3_backup_init")
+        have_func("sqlite3_column_database_name")
+        have_func("sqlite3_enable_load_extension")
+        have_func("sqlite3_load_extension")
+
+        unless have_func("sqlite3_open_v2") # https://www.sqlite.org/releaselog/3_5_0.html
+          abort("\nPlease use a version of SQLite3 >= 3.5.0\n\n")
+        end
+
+        have_func("sqlite3_prepare_v2")
+        have_func("sqlite3_db_name", "sqlite3.h") # v3.39.0
+        have_func("sqlite3_error_offset", "sqlite3.h") # v3.38.0
+
+        have_type("sqlite3_int64", "sqlite3.h")
+        have_type("sqlite3_uint64", "sqlite3.h")
+      end
+
+      def minimal_recipe
+        require "mini_portile2"
+
+        MiniPortile.new(libname, sqlite3_config[:version]).tap do |recipe|
+          if sqlite_source_dir
+            recipe.source_directory = sqlite_source_dir
+          else
+            recipe.files = sqlite3_config[:files]
+            recipe.target = File.join(package_root_dir, "ports")
+            recipe.patch_files = Dir[File.join(package_root_dir, "patches", "*.patch")].sort
+          end
+        end
+      end
+
+      def package_root_dir
+        File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+      end
+
+      def sqlite3_config
+        mini_portile_config[:sqlite3]
+      end
+
+      def mini_portile_config
+        YAML.load_file(File.join(package_root_dir, "dependencies.yml"), symbolize_names: true)
+      end
+
+      def abort_could_not_find(missing)
+        abort("\nCould not find #{missing}.\nPlease visit https://github.com/sparklemotion/sqlite3-ruby for installation instructions.\n\n")
+      end
+
+      def abort_pkg_config(id)
+        abort("\nCould not configure the build properly (#{id}). Please install the `pkg-config` utility.\n\n")
+      end
+
+      def cross_build?
+        enable_config("cross-build")
+      end
+
+      def sqlite_source_dir
+        arg_config("--with-sqlite-source-dir")
+      end
+
+      def download
+        minimal_recipe.download
+      end
+
+      def darwin?
+        RbConfig::CONFIG["target_os"].include?("darwin")
+      end
+
+      def windows?
+        RbConfig::CONFIG["target_os"].match?(/mingw|mswin/)
+      end
+
+      def print_help
+        print(<<~TEXT)
+          USAGE: ruby #{$PROGRAM_NAME} [options]
+
+            Flags that are always valid:
+
+                --disable-system-libraries
+                    Use the packaged libraries, and ignore the system libraries.
+                    (This is the default behavior.)
+
+                --enable-system-libraries
+                    Use system libraries instead of building and using the packaged libraries.
+
+                --with-sqlcipher
+                    Use libsqlcipher instead of libsqlite3.
+                    (Implies `--enable-system-libraries`.)
+
+                --with-sqlite-source-dir=DIRECTORY
+                    (dev only) Build sqlite from the source code in DIRECTORY
+
+                --help
+                    Display this message.
+
+
+            Flags only used when using system libraries:
+
+                General (applying to all system libraries):
+
+                    --with-opt-dir=DIRECTORY
+                        Look for headers and libraries in DIRECTORY.
+
+                    --with-opt-lib=DIRECTORY
+                        Look for libraries in DIRECTORY.
+
+                    --with-opt-include=DIRECTORY
+                        Look for headers in DIRECTORY.
+
+                Related to sqlcipher:
+
+                    --with-sqlcipher-dir=DIRECTORY
+                        Look for sqlcipher headers and library in DIRECTORY.
+                        (Implies `--with-sqlcipher` and `--enable-system-libraries`.)
+
+                    --with-sqlcipher-lib=DIRECTORY
+                        Look for sqlcipher library in DIRECTORY.
+                        (Implies `--with-sqlcipher` and `--enable-system-libraries`.)
+
+                    --with-sqlcipher-include=DIRECTORY
+                        Look for sqlcipher headers in DIRECTORY.
+                        (Implies `--with-sqlcipher` and `--enable-system-libraries`.)
+
+
+            Flags only used when building and using the packaged libraries:
+
+                --with-sqlite-cflags=CFLAGS
+                    Explicitly pass compiler flags to the sqlite library build. These flags will
+                    appear on the commandline before any flags set in the CFLAGS environment
+                    variable. This is useful for setting compilation options in your project's
+                    bundler config. See INSTALLATION.md for more information.
+
+                --enable-cross-build
+                    Enable cross-build mode. (You probably do not want to set this manually.)
+
+
+            Environment variables used for compiling the gem's C extension:
+
+                CC
+                    Use this path to invoke the compiler instead of `RbConfig::CONFIG['CC']`
+
+
+            Environment variables passed through to the compilation of sqlite:
+
+                CC
+                CPPFLAGS
+                CFLAGS
+                LDFLAGS
+                LIBS
+                LT_SYS_LIBRARY_PATH
+                CPP
+
+        TEXT
+      end
+    end
+  end
+end
+
+if arg_config("--help")
+  Sqlite3::ExtConf.print_help
+  exit!(0)
+end
+
+if arg_config("--download-dependencies")
+  Sqlite3::ExtConf.download
+  exit!(0)
+end
+
+Sqlite3::ExtConf.configure

data/ext/sqlite3/gvl.c

@@ -0,0 +1,88 @@
+#include <sqlite3_ruby.h>
+#include <ruby/thread.h>
+
+#if defined(_MSC_VER)
+#  define SQLITE3_TLS __declspec(thread)
+#else
+#  define SQLITE3_TLS __thread
+#endif
+
+/* Per OS thread: set while this thread is inside a without_gvl sqlite call. */
+static SQLITE3_TLS int in_nogvl = 0;
+
+/* Unblocking function: Thread#kill / Thread#raise call this from another
+ * thread; sqlite3_interrupt is thread-safe and makes the running call return
+ * SQLITE_INTERRUPT. */
+static void
+interrupt_db(void *db)
+{
+    sqlite3_interrupt((sqlite3 *)db);
+}
+
+static void *
+step_body(void *stmt)
+{
+    return (void *)(intptr_t)sqlite3_step((sqlite3_stmt *)stmt);
+}
+
+int
+rb_sqlite3_step_without_gvl(sqlite3_stmt *stmt)
+{
+    int was_nogvl = in_nogvl;
+    int status;
+
+    in_nogvl = 1;
+    status = (int)(intptr_t)rb_thread_call_without_gvl(
+                 step_body, stmt, interrupt_db, sqlite3_db_handle(stmt));
+
+    in_nogvl = was_nogvl;
+
+    return status;
+}
+
+typedef struct {
+    sqlite3 *db;
+    const char *sql;
+    sqlite3_callback callback;
+    void *callback_arg;
+    char **errmsg;
+} exec_args_t;
+
+static void *
+exec_body(void *ptr)
+{
+    exec_args_t *args = (exec_args_t *)ptr;
+    return (void *)(intptr_t)sqlite3_exec(
+               args->db, args->sql, args->callback, args->callback_arg, args->errmsg);
+}
+
+int
+rb_sqlite3_exec_without_gvl(sqlite3 *db, const char *sql, sqlite3_callback callback,
+                            void *callback_arg, char **errmsg)
+{
+    exec_args_t args = { db, sql, callback, callback_arg, errmsg };
+    int was_nogvl = in_nogvl;
+    int status;
+
+    in_nogvl = 1;
+    status = (int)(intptr_t)rb_thread_call_without_gvl(exec_body, &args, interrupt_db, db);
+    in_nogvl = was_nogvl;
+
+    return status;
+}
+
+/* Callbacks also fire from sqlite calls made with the GVL held (prepare,
+ * close), and taking the GVL twice is a fatal error. */
+void *
+rb_sqlite3_with_gvl(void *(*func)(void *), void *data)
+{
+    void *result;
+
+    if (!in_nogvl) { return func(data); }
+
+    in_nogvl = 0;
+    result = rb_thread_call_with_gvl(func, data);
+    in_nogvl = 1;
+
+    return result;
+}

data/ext/sqlite3/gvl.h

@@ -0,0 +1,15 @@
+#ifndef SQLITE3_GVL_RUBY
+#define SQLITE3_GVL_RUBY
+
+#include <sqlite3_ruby.h>
+
+/* sqlite3_step and sqlite3_exec run without the GVL so other threads keep
+ * running, and so Thread#kill / Thread#raise can cancel them through
+ * sqlite3_interrupt. sqlite calls Ruby callbacks on the same thread, so each
+ * callback goes through rb_sqlite3_with_gvl to take the GVL back first. */
+int rb_sqlite3_step_without_gvl(sqlite3_stmt *stmt);
+int rb_sqlite3_exec_without_gvl(sqlite3 *db, const char *sql, sqlite3_callback callback,
+                                void *callback_arg, char **errmsg);
+void *rb_sqlite3_with_gvl(void *(*func)(void *), void *data);
+
+#endif