Support SQLite libraries without auto-init

simolus3#277

Author: simolus3

.github/workflows/main.yml

@@ -15,15 +15,15 @@ jobs:
     name: Compile sqlite3 for ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     env:
-      SQLITE_YEAR: "2024"
-      SQLITE_VERSION: "3470200"
+      SQLITE_YEAR: "2025"
+      SQLITE_VERSION: "3480000"
 
     steps:
     - uses: actions/cache@v4
       id: cache_sqlite_build
       with:
         path: sqlite/out
-        key: sqlite-v3-${{ runner.os }}-${{ env.SQLITE_VERSION }}
+        key: sqlite-v4-${{ runner.os }}-${{ env.SQLITE_VERSION }}
     - name: Compile sqlite3 on Linux
       if: steps.cache_sqlite_build.outputs.cache-hit != 'true' && runner.os == 'Linux'
       run: |
@@ -38,6 +38,18 @@ jobs:
         cp sqlite3 ../out
         cp .libs/libsqlite3.so ../out
         cp *.h ../out
+    - name: Compile sqlite3 on Linux (no autoinit)
+      if: steps.cache_sqlite_build.outputs.cache-hit != 'true' && runner.os == 'Linux'
+      working-directory: sqlite
+      run: |
+        curl https://www.sqlite.org/$SQLITE_YEAR/sqlite-amalgamation-$SQLITE_VERSION.zip --output sqlite.zip
+        unzip sqlite.zip
+
+        cd sqlite-amalgamation-$SQLITE_VERSION
+        gcc -DSQLITE_OMIT_AUTOINIT=1 -c -fPIC sqlite3.c -o sqlite3.o
+        gcc -shared sqlite3.o -o libsqlite3.so
+        mkdir ../out/without_autoinit
+        cp libsqlite3.so ../out/without_autoinit
     - name: Compile sqlite3 on macOS
       if: steps.cache_sqlite_build.outputs.cache-hit != 'true' && runner.os == 'macOS'
       run: |
@@ -179,6 +191,16 @@ jobs:
         dart test -P ci
       working-directory: sqlite3/
 
+    - name: Test with SQLITE_OMIT_AUTOINIT
+      if: runner.os == 'Linux'
+      run: |
+        ls $LD_LIBRARY_PATH
+        dart run tool/check_compile_time_option.dart OMIT_AUTOINIT
+        dart test -P ci
+      env:
+        LD_LIBRARY_PATH: ../sqlite/out/without_autoinit
+      working-directory: sqlite3/
+
     - name: Test sqlite3_test package
       run: |
         dart pub get

sqlite3/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Fix out-of-bound reads in the `xWrite` implementation of the OPFS-locks based
   file-system implementation when writing more than 64 KiB in one operation.
+- Support SQLite libraries compiled with `SQLITE_OMIT_AUTOINIT`.
 
 ## 2.6.0
 

sqlite3/assets/sqlite3.h

@@ -1,3 +1,6 @@
+// This file defines the definitions for which we generate FFI bindings on
+// native platforms. To re-generate bindings, run:
+// `dart run ffigen --config ffigen.yaml`.
 #include <stdint.h>
 
 typedef struct sqlite3_char sqlite3_char;
@@ -8,6 +11,8 @@ typedef struct sqlite3_api_routines sqlite3_api_routines;
 
 sqlite3_char *sqlite3_temp_directory;
 
+int sqlite3_initialize();
+
 int sqlite3_open_v2(sqlite3_char *filename, sqlite3 **ppDb, int flags,
                     sqlite3_char *zVfs);
 int sqlite3_close_v2(sqlite3 *db);

sqlite3/lib/src/ffi/bindings.dart

@@ -84,6 +84,11 @@ final class FfiBindings extends RawSqliteBindings {
     }
   }
 
+  @override
+  int sqlite3_initialize() {
+    return bindings.bindings.sqlite3_initialize();
+  }
+
   @override
   String sqlite3_errstr(int extendedErrorCode) {
     return bindings.bindings.sqlite3_errstr(extendedErrorCode).readString();

sqlite3/lib/src/ffi/implementation.dart

@@ -51,6 +51,8 @@ final class FfiSqlite3 extends Sqlite3Implementation implements Sqlite3 {
 
   @override
   void ensureExtensionLoaded(SqliteExtension extension) {
+    initialize();
+
     final entrypoint = (extension as SqliteExtensionImpl)._resolveEntrypoint;
     final functionPtr = entrypoint(ffiBindings.bindings.library);
 

sqlite3/lib/src/ffi/sqlite3.g.dart

@@ -28,6 +28,15 @@ class Bindings {
   set sqlite3_temp_directory(ffi.Pointer<sqlite3_char> value) =>
       _sqlite3_temp_directory.value = value;
 
+  int sqlite3_initialize() {
+    return _sqlite3_initialize();
+  }
+
+  late final _sqlite3_initializePtr =
+      _lookup<ffi.NativeFunction<ffi.Int Function()>>('sqlite3_initialize');
+  late final _sqlite3_initialize =
+      _sqlite3_initializePtr.asFunction<int Function()>();
+
   int sqlite3_open_v2(
     ffi.Pointer<sqlite3_char> filename,
     ffi.Pointer<ffi.Pointer<sqlite3>> ppDb,

sqlite3/lib/src/implementation/bindings.dart

@@ -40,6 +40,8 @@ abstract base class RawSqliteBindings {
 
   void registerVirtualFileSystem(VirtualFileSystem vfs, int makeDefault);
   void unregisterVirtualFileSystem(VirtualFileSystem vfs);
+
+  int sqlite3_initialize();
 }
 
 /// Combines a sqlite result code and the result object.

sqlite3/lib/src/implementation/sqlite3.dart

@@ -2,6 +2,7 @@ import 'package:meta/meta.dart';
 
 import '../constants.dart';
 import '../database.dart';
+import '../exception.dart';
 import '../sqlite3.dart';
 import '../vfs.dart';
 import 'bindings.dart';
@@ -24,12 +25,21 @@ base class Sqlite3Implementation implements CommonSqlite3 {
   @override
   set tempDirectory(String? value) => bindings.sqlite3_temp_directory = value;
 
+  void initialize() {
+    final rc = bindings.sqlite3_initialize();
+    if (rc != 0) {
+      throw SqliteException(rc, 'Error returned by sqlite3_initialize');
+    }
+  }
+
   @override
   CommonDatabase open(String filename,
       {String? vfs,
       OpenMode mode = OpenMode.readWriteCreate,
       bool uri = false,
       bool? mutex}) {
+    initialize();
+
     int flags;
     switch (mode) {
       case OpenMode.readOnly:

sqlite3/lib/src/wasm/bindings.dart

@@ -5,7 +5,6 @@ import 'dart:typed_data';
 import 'package:sqlite3/src/vfs.dart';
 
 import '../constants.dart';
-import '../exception.dart';
 import '../functions.dart';
 import '../implementation/bindings.dart';
 import 'wasm_interop.dart' as wasm;
@@ -56,8 +55,6 @@ final class WasmSqliteBindings extends RawSqliteBindings {
   @override
   SqliteResult<RawSqliteDatabase> sqlite3_open_v2(
       String name, int flags, String? zVfs) {
-    sqlite3_initialize();
-
     final namePtr = bindings.allocateZeroTerminated(name);
     final outDb = bindings.malloc(wasm.WasmBindings.pointerSize);
     final vfsPtr = zVfs == null ? 0 : bindings.allocateZeroTerminated(zVfs);
@@ -79,11 +76,9 @@ final class WasmSqliteBindings extends RawSqliteBindings {
     return bindings.memory.readString(bindings.sqlite3_sourceid());
   }
 
-  void sqlite3_initialize() {
-    final rc = bindings.sqlite3_initialize();
-    if (rc != 0) {
-      throw SqliteException(rc, 'sqlite3_initialize call failed');
-    }
+  @override
+  int sqlite3_initialize() {
+    return bindings.sqlite3_initialize();
   }
 
   @override
@@ -95,7 +90,6 @@ final class WasmSqliteBindings extends RawSqliteBindings {
     if (ptr == 0) {
       throw StateError('could not register vfs');
     }
-    sqlite3_initialize();
     DartCallbacks.sqliteVfsPointer[vfs] = ptr;
   }
 

sqlite3/test/source_code_test.dart

@@ -8,7 +8,7 @@ import 'package:analyzer/dart/analysis/utilities.dart';
 import 'package:test/test.dart';
 
 void main() {
-  test('drift does not import legacy JS interop files', () {
+  test('does not import legacy JS interop files', () {
     final failures = <(String, String)>[];
 
     void check(FileSystemEntity e) {