libdoltlite-sys 0.38.26

Native bindings to the DoltLite SQLite-compatible library
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
#![expect(non_snake_case, non_camel_case_types)]
#![cfg_attr(not(test), no_std)]
pub use self::error::*;

use core::mem;
#[cfg(not(feature = "loadable_extension"))]
use core::sync::atomic::{AtomicI32, Ordering};

mod error;

// Keep Cargo's native curl/OpenSSL/zlib link metadata reachable through this
// sys crate without exposing those low-level crates as part of its API.
#[cfg(feature = "blockcachevfs")]
extern crate curl_sys as _;
#[cfg(feature = "blockcachevfs")]
extern crate libz_sys as _;
#[cfg(feature = "blockcachevfs")]
extern crate openssl_sys as _;

#[must_use]
pub fn SQLITE_STATIC() -> sqlite3_destructor_type {
    None
}

#[must_use]
pub fn SQLITE_TRANSIENT() -> sqlite3_destructor_type {
    Some(unsafe { mem::transmute::<isize, unsafe extern "C" fn(*mut core::ffi::c_void)>(-1_isize) })
}

#[allow(dead_code, clippy::all)]
mod bindings {
    include!(concat!(env!("OUT_DIR"), "/bindgen.rs"));
}
pub use bindings::*;

/// Raw Cloud Backed SQLite block-cache VFS interface.
#[cfg(feature = "blockcachevfs")]
pub mod blockcachevfs {
    use core::ffi::{c_char, c_int, c_void};

    use super::{sqlite3, sqlite3_int64};

    /// Opaque Cloud Backed SQLite VFS handle.
    #[repr(C)]
    pub struct sqlite3_bcvfs {
        _private: [u8; 0],
    }

    /// Authentication callback used by the CBS VFS.
    pub type sqlite3_bcvfs_auth_callback = unsafe extern "C" fn(
        p_ctx: *mut c_void,
        z_storage: *const c_char,
        z_account: *const c_char,
        z_container: *const c_char,
        pz_auth_token: *mut *mut c_char,
    ) -> c_int;

    /// Request-boundary credential refresh callback for session-owned cloud VFSes.
    pub type sqlite3_bcvfs_auth_refresh_callback = unsafe extern "C" fn(
        p_ctx: *mut c_void,
        z_storage: *const c_char,
        z_account: *const c_char,
        z_container: *const c_char,
        reason: c_int,
        pz_auth_token: *mut *mut c_char,
    ) -> c_int;

    /// Upload progress event with block and full-block-byte counts.
    pub type sqlite3_bcvfs_upload_progress_callback =
        unsafe extern "C" fn(*mut c_void, c_int, sqlite3_int64, sqlite3_int64);

    /// A safe, credential-free terminal storage failure observed by the VFS.
    pub type sqlite3_bcvfs_storage_failure_callback =
        unsafe extern "C" fn(*mut c_void, c_int, c_int, c_int);

    /// Busy callback used by an upload checkpoint.
    pub type sqlite3_bcvfs_busy_callback = unsafe extern "C" fn(*mut c_void, c_int) -> c_int;

    pub const SQLITE_BCV_CACHESIZE: c_int = 1;
    pub const SQLITE_BCV_NREQUEST: c_int = 2;
    pub const SQLITE_BCV_HTTPTIMEOUT: c_int = 3;
    pub const SQLITE_BCV_CURLVERBOSE: c_int = 4;
    pub const SQLITE_BCV_HTTPLOG_TIMEOUT: c_int = 5;
    pub const SQLITE_BCV_HTTPLOG_NENTRY: c_int = 6;
    /// Proactively stage dirty blocks once this percentage of the cache is occupied.
    pub const SQLITE_BCV_STAGEWATERMARK: c_int = 7;
    pub const SQLITE_BCV_AUTH_REQUEST: c_int = 0;
    pub const SQLITE_BCV_AUTH_UNAUTHORIZED: c_int = 1;
    pub const SQLITE_BCVFS_UPLOAD_PROGRESS_UPLOADED_BLOCK: c_int = 1;
    pub const SQLITE_BCVFS_UPLOAD_PROGRESS_REUSED_BLOCK: c_int = 2;
    pub const SQLITE_BCVFS_UPLOAD_PROGRESS_PLAN: c_int = 3;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_CAUSE_SQLITE: c_int = 0;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_CAUSE_HTTP: c_int = 1;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_LOCAL_CACHE: c_int = 1;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_BLOCK_READ: c_int = 2;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_STAGE_PUT: c_int = 3;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_VERIFY_EXISTING: c_int = 4;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_PROTECT_SESSION: c_int = 5;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_FINAL_PUT: c_int = 6;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_SESSION_CHECKPOINT: c_int = 7;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_SESSION_ACCEPT: c_int = 8;
    pub const SQLITE_BCVFS_STORAGE_FAILURE_SESSION_PUBLISH: c_int = 9;

    pub const SQLITE_BCV_ATTACH_SECURE: c_int = 0x0001;
    pub const SQLITE_BCV_ATTACH_IFNOT: c_int = 0x0002;
    pub const SQLITE_BCVFS_SESSION_HASH_BYTES: usize = 32;
    pub const SQLITE_BCVFS_SESSION_STATUS_NEW: c_int = 0;
    pub const SQLITE_BCVFS_SESSION_STATUS_ACCEPTED: c_int = 1;
    pub const SQLITE_BCVFS_SESSION_STATUS_COMMITTED: c_int = 2;
    pub const SQLITE_BCVFS_SESSION_STATUS_FAILED: c_int = 3;
    pub const SQLITE_BCVFS_SESSION_STATUS_CONFLICT: c_int = 4;

    unsafe extern "C" {
        pub fn sqlite3_bcvfs_create(
            z_dir: *const c_char,
            z_name: *const c_char,
            pp_fs: *mut *mut sqlite3_bcvfs,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_destroy(fs: *mut sqlite3_bcvfs) -> c_int;
        pub fn sqlite3_bcvfs_isdaemon(fs: *mut sqlite3_bcvfs) -> c_int;
        pub fn sqlite3_bcvfs_register_vtab(db: *mut sqlite3) -> c_int;
        pub fn sqlite3_bcvfs_config(
            fs: *mut sqlite3_bcvfs,
            op: c_int,
            value: sqlite3_int64,
        ) -> c_int;
        pub fn sqlite3_bcvfs_auth_callback(
            fs: *mut sqlite3_bcvfs,
            auth_ctx: *mut c_void,
            auth: Option<sqlite3_bcvfs_auth_callback>,
        ) -> c_int;
        pub fn sqlite3_bcvfs_auth_refresh_callback(
            fs: *mut sqlite3_bcvfs,
            auth_ctx: *mut c_void,
            auth: Option<sqlite3_bcvfs_auth_refresh_callback>,
        ) -> c_int;
        pub fn sqlite3_bcvfs_upload_progress_callback(
            fs: *mut sqlite3_bcvfs,
            progress_ctx: *mut c_void,
            progress: Option<sqlite3_bcvfs_upload_progress_callback>,
        ) -> c_int;
        pub fn sqlite3_bcvfs_storage_failure_callback(
            fs: *mut sqlite3_bcvfs,
            failure_ctx: *mut c_void,
            failure: Option<sqlite3_bcvfs_storage_failure_callback>,
        ) -> c_int;
        pub fn sqlite3_bcvfs_attach(
            fs: *mut sqlite3_bcvfs,
            z_storage: *const c_char,
            z_account: *const c_char,
            z_container: *const c_char,
            z_alias: *const c_char,
            flags: c_int,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_attach_session(
            fs: *mut sqlite3_bcvfs,
            z_storage: *const c_char,
            z_account: *const c_char,
            z_container: *const c_char,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            flags: c_int,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_attach_session_scoped(
            fs: *mut sqlite3_bcvfs,
            z_storage: *const c_char,
            z_account: *const c_char,
            z_container: *const c_char,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            z_principal: *const c_char,
            z_database: *const c_char,
            z_operations: *const c_char,
            a_operation_id: *const u8,
            flags: c_int,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_detach_session(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_detach(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_poll(
            fs: *mut sqlite3_bcvfs,
            z_container: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_upload(
            fs: *mut sqlite3_bcvfs,
            z_container: *const c_char,
            busy: Option<sqlite3_bcvfs_busy_callback>,
            busy_ctx: *mut c_void,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        /// Initialize an empty DoltLite store without creating a zero-tip branch.
        ///
        /// The connection must have been opened with DoltLite's private no-seed
        /// flag. This serializes and commits an empty refs table for the named
        /// SQLite schema.
        ///
        /// # Safety
        /// `db` must be a live SQLite connection and `z_db` must point to a
        /// NUL-terminated schema name valid for that connection.
        pub fn sqlite3_doltlite_bcvfs_initialize_empty_store(
            db: *mut sqlite3,
            z_db: *const c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_session_checkpoint(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            checkpoint_hash: *mut u8,
            pz_etag: *mut *mut c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_session_rehydrate(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_session_upload(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_session_finalize(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_session_accept(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            pz_etag: *mut *mut c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_session_operation_status(
            fs: *mut sqlite3_bcvfs,
            z_alias: *const c_char,
            z_session_id: *const c_char,
            p_status: *mut c_int,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        pub fn sqlite3_bcvfs_delete(
            fs: *mut sqlite3_bcvfs,
            z_container: *const c_char,
            z_database: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
        /// Copy a database in an attached container to a new manifest name.
        ///
        /// # Safety
        /// `fs` must be live, all names must be NUL-terminated C strings, and
        /// `pz_err` must be null or writable for an allocated error pointer.
        pub fn sqlite3_bcvfs_copy(
            fs: *mut sqlite3_bcvfs,
            z_container: *const c_char,
            z_from: *const c_char,
            z_to: *const c_char,
            pz_err: *mut *mut c_char,
        ) -> c_int;
    }
}

/// Raw Cloud Backed SQLite database-management interface.
#[cfg(feature = "blockcachevfs")]
pub mod bcvutil {
    use core::ffi::{c_char, c_int};

    /// Opaque Cloud Backed SQLite database-management handle.
    #[repr(C)]
    pub struct sqlite3_bcv {
        _private: [u8; 0],
    }

    unsafe extern "C" {
        pub fn sqlite3_bcv_open(
            z_module: *const c_char,
            z_user: *const c_char,
            z_auth: *const c_char,
            z_container: *const c_char,
            pp_out: *mut *mut sqlite3_bcv,
        ) -> c_int;
        pub fn sqlite3_bcv_close(handle: *mut sqlite3_bcv);
        pub fn sqlite3_bcv_errmsg(handle: *mut sqlite3_bcv) -> *const c_char;
        pub fn sqlite3_bcv_upload(
            handle: *mut sqlite3_bcv,
            z_local: *const c_char,
            z_remote: *const c_char,
        ) -> c_int;
        pub fn sqlite3_bcv_cleanup(handle: *mut sqlite3_bcv, n_second: c_int) -> c_int;
        pub fn sqlite3_bcv_create_if_not_exists(
            handle: *mut sqlite3_bcv,
            sz_name: c_int,
            sz_block: c_int,
        ) -> c_int;
    }
}

#[cfg(all(feature = "remote", not(target_arch = "wasm32")))]
mod remote {
    use core::ffi::{c_char, c_int, c_long, c_void};

    use super::{sqlite3, sqlite3_int64};

    pub const DOLTLITE_PUSH_PROGRESS_PLAN: c_int = 1;
    pub const DOLTLITE_PUSH_PROGRESS_UPLOADED: c_int = 2;

    pub const DOLTLITE_CLONE_PROGRESS_STARTED: c_int = 1;
    pub const DOLTLITE_CLONE_PROGRESS_PROGRESS: c_int = 2;
    pub const DOLTLITE_CLONE_PROGRESS_FINALIZING: c_int = 3;
    pub const DOLTLITE_CLONE_PROGRESS_COMPLETED: c_int = 4;

    pub type sqlite3_doltlite_push_progress_callback =
        unsafe extern "C" fn(*mut c_void, c_int, sqlite3_int64, sqlite3_int64);
    pub type sqlite3_doltlite_clone_progress_callback = unsafe extern "C" fn(
        *mut c_void,
        c_int,
        sqlite3_int64,
        sqlite3_int64,
        sqlite3_int64,
        sqlite3_int64,
    );

    #[repr(C)]
    pub struct DoltliteServer {
        _private: [u8; 0],
    }

    #[repr(C)]
    pub struct DoltliteServeOpts {
        pub zDir: *const c_char,
        pub port: c_int,
        pub zBindAddr: *const c_char,
        pub certFile: *const c_char,
        pub keyFile: *const c_char,
        pub authKeysDir: *const c_char,
        pub audience: *const c_char,
        pub timeoutMs: c_int,
        pub zVfsName: *const c_char,
        pub bSessionLoopbackTransfer: c_int,
    }

    unsafe extern "C" {
        /// Install a connection-scoped callback for opt-in native `dolt_push` progress.
        ///
        /// On success, `context` must remain valid until the matching clear call.
        /// On failure, ownership remains with the caller.
        pub fn sqlite3_doltlite_set_push_progress_callback(
            db: *mut sqlite3,
            context: *mut c_void,
            callback: Option<sqlite3_doltlite_push_progress_callback>,
        ) -> c_int;

        /// Clear the callback only if `context` still owns the registration.
        pub fn sqlite3_doltlite_clear_push_progress_callback(
            db: *mut sqlite3,
            context: *mut c_void,
        ) -> c_int;

        /// Install a connection-scoped callback for opt-in native `dolt_clone` progress.
        ///
        /// On success, `context` must remain valid until the matching clear call.
        /// On failure, ownership remains with the caller.
        pub fn sqlite3_doltlite_set_clone_progress_callback(
            db: *mut sqlite3,
            context: *mut c_void,
            callback: Option<sqlite3_doltlite_clone_progress_callback>,
        ) -> c_int;

        /// Clear the clone callback only if `context` still owns the registration.
        pub fn sqlite3_doltlite_clear_clone_progress_callback(
            db: *mut sqlite3,
            context: *mut c_void,
        ) -> c_int;

        pub fn doltliteServe(
            directory: *const c_char,
            port: c_int,
            bind_address: *const c_char,
        ) -> c_int;

        pub fn doltliteServeAsync(
            directory: *const c_char,
            port: c_int,
            bind_address: *const c_char,
        ) -> *mut DoltliteServer;

        pub fn doltliteServeOpts(options: *const DoltliteServeOpts) -> c_int;

        pub fn doltliteServeAsyncOpts(options: *const DoltliteServeOpts) -> *mut DoltliteServer;

        pub fn doltliteServerStop(server: *mut DoltliteServer);

        pub fn doltliteServerPort(server: *mut DoltliteServer) -> c_int;

        pub fn doltliteCredsVerifyBearer(
            authorization: *const c_char,
            expected_audience: *const c_char,
            authorized_keys_directory: *const c_char,
            now: c_long,
            key_id: *mut *mut c_char,
        ) -> c_int;
    }
}

#[cfg(all(feature = "remote", not(target_arch = "wasm32")))]
pub use remote::*;

#[cfg(not(feature = "loadable_extension"))]
unsafe extern "C" {
    fn doltliteInstallAutoExt() -> core::ffi::c_int;
}

#[cfg(not(feature = "loadable_extension"))]
static DOLTLITE_INIT_RESULT: AtomicI32 = AtomicI32::new(i32::MIN);

#[cfg(feature = "loadable_extension")]
pub fn initialize_doltlite() -> core::ffi::c_int {
    // A loadable extension runs inside an already-initialized host process;
    // do not load DoltLite's process-wide auto-extension a second time.
    SQLITE_OK
}

#[cfg(not(feature = "loadable_extension"))]
pub fn initialize_doltlite() -> core::ffi::c_int {
    let existing = DOLTLITE_INIT_RESULT.load(Ordering::Acquire);
    if existing != i32::MIN {
        return existing;
    }

    let result = unsafe { doltliteInstallAutoExt() };
    match DOLTLITE_INIT_RESULT.compare_exchange(
        i32::MIN,
        result,
        Ordering::AcqRel,
        Ordering::Acquire,
    ) {
        Ok(_) => result,
        Err(previous) => previous,
    }
}

impl Default for sqlite3_vtab {
    fn default() -> Self {
        unsafe { mem::zeroed() }
    }
}

impl Default for sqlite3_vtab_cursor {
    fn default() -> Self {
        unsafe { mem::zeroed() }
    }
}