sqlite_wasm_reader 0.3.1

A pure Rust SQLite reader library for WASI environments
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
//! B-tree traversal functionality

use crate::{Error, Result, page::Page, logging::log_warn, logging::log_debug, value::Value};

#[cfg(all(target_arch = "wasm32", not(target_os = "wasi")))]
use alloc::vec::Vec;

/// Cell in a B-tree page
#[derive(Debug)]
#[allow(dead_code)]
pub struct Cell {
    /// Left child page number (for interior pages)
    pub left_child: Option<u32>,
    /// Key (rowid for table b-trees)
    pub key: i64,
    /// Payload data
    pub payload: Vec<u8>,
}

/// An entry in an index B-tree
#[derive(Debug)]
struct IndexCell {
    /// The indexed value(s)
    pub key: Vec<Value>,
    /// The rowid of the corresponding row
    pub rowid: i64,
}

/// An entry in an interior index page
#[derive(Debug)]
struct InteriorIndexCell {
    /// The page number of the left child.
    pub left_child: u32,
    /// The indexed value(s)
    pub key: Vec<Value>,
}

/// B-tree cursor for traversing pages
pub struct BTreeCursor {
    /// Stack of pages being traversed
    /// Each entry contains: (page, current_cell_index)
    page_stack: Vec<(Page, usize)>,
    /// Track visited pages to prevent infinite loops
    visited_pages: Vec<u32>,
    /// Safety counter to prevent infinite loops
    iteration_count: usize,
}

impl BTreeCursor {
    /// Create a new cursor starting at the given page
    pub fn new(root_page: Page) -> Self {
        let page_number = root_page.page_number;
        BTreeCursor {
            page_stack: vec![(root_page, 0)],
            visited_pages: vec![page_number],
            iteration_count: 0,
        }
    }
    
    /// Find a cell with the specified key (ROWID) in the B-tree
    pub fn find_cell<F>(&mut self, key: i64, mut read_page: F) -> Result<Option<Cell>>
    where
        F: FnMut(u32) -> Result<Page>,
    {
        if self.page_stack.is_empty() {
            return Ok(None);
        }

        let root_page_num = self.page_stack[0].0.page_number;
        let mut current_page = read_page(root_page_num)?;

        loop {
            if current_page.page_type.is_leaf() {
                let cell_pointers = current_page.cell_pointers(current_page.page_number == 1)?;

                // Binary search for the key in this leaf page
                let mut low = 0;
                let mut high = cell_pointers.len();

                while low < high {
                    let mid = low + (high - low) / 2;
                    let cell_offset = cell_pointers[mid];
                    let cell_data = current_page.cell_content(cell_offset)?;
                    let cell = parse_leaf_table_cell(&cell_data)?;

                    match cell.key.cmp(&key) {
                        std::cmp::Ordering::Equal => return Ok(Some(cell)),
                        std::cmp::Ordering::Less => low = mid + 1,
                        std::cmp::Ordering::Greater => high = mid,
                    }
                }

                // Key not found
                return Ok(None);
            } else {
                // This is an interior page, find the appropriate child page to descend to.
                let cell_pointers = current_page.cell_pointers(current_page.page_number == 1)?;

                let mut next_page_num = current_page.right_pointer.ok_or_else(|| {
                    Error::InvalidFormat("Interior page missing right pointer".into())
                })?;

                for &cell_offset in cell_pointers.iter() {
                    let cell_data = current_page.cell_content(cell_offset)?;
                    let cell = parse_interior_table_cell(&cell_data)?;
                    if key <= cell.key {
                        next_page_num = cell.left_child.unwrap();
                        break;
                    }
                }

                // Descend to the child page.
                current_page = read_page(next_page_num)?;
            }
        }
    }
    
    /// Move to the next cell in the B-tree using in-order traversal
    pub fn next_cell<F>(&mut self, mut read_page: F) -> Result<Option<Cell>>
    where
        F: FnMut(u32) -> Result<Page>,
    {
        // Safety check: prevent infinite loops
        self.iteration_count += 1;
        if self.iteration_count > 100_000 {
            return Err(Error::InvalidFormat("B-tree traversal exceeded safety limit".into()));
        }
        
        loop {
            if self.page_stack.is_empty() {
                return Ok(None);
            }
            
            let (page, cell_index) = self.page_stack.last_mut().unwrap();
            
            // If this is a leaf page
            if page.page_type.is_leaf() {
                // If we've processed all cells in this leaf page
                if *cell_index >= page.cell_count as usize {
                    // Pop this page and continue with parent
                    self.page_stack.pop();
                    continue;
                }
                
                // Get the current cell from leaf page
                let is_first_page = page.page_number == 1;
                let cell_pointers = match page.cell_pointers(is_first_page) {
                    Ok(pointers) => pointers,
                    Err(e) => {
                        log_warn(&format!("Failed to get cell pointers for page {}: {}", page.page_number, e));
                        // Skip this page and continue with parent
                        self.page_stack.pop();
                        continue;
                    }
                };
                
                if *cell_index >= cell_pointers.len() {
                    // Pop this page and continue with parent
                    self.page_stack.pop();
                    continue;
                }
                
                let cell_offset = cell_pointers[*cell_index];
                let cell_data = match page.cell_content(cell_offset) {
                    Ok(data) => data,
                    Err(e) => {
                        log_warn(&format!("Failed to get cell content at offset {} on page {}: {}", cell_offset, page.page_number, e));
                        // Skip this cell and move to next
                        *cell_index += 1;
                        continue;
                    }
                };
                
                // Move to next cell in current page
                *cell_index += 1;
                
                // Parse and return the leaf cell
                let cell = match parse_leaf_table_cell(cell_data) {
                    Ok(cell) => cell,
                    Err(e) => {
                        log_debug(&format!("Failed to parse leaf cell on page {}: {}", page.page_number, e));
                        // Skip this cell and continue to next iteration
                        continue;
                    }
                };
                return Ok(Some(cell));
            }
            
            // This is an interior page
            if *cell_index >= page.cell_count as usize {
                // We've processed all cells in this interior page
                // Follow the right-most pointer if it exists
                if let Some(right_ptr) = page.right_pointer {
                    // Safety check: prevent revisiting the same page
                    if self.visited_pages.contains(&right_ptr) {
                        // We're about to revisit a page, this indicates a cycle
                        // Pop this page and continue with parent instead
                        self.page_stack.pop();
                        continue;
                    }
                    
                    let right_page = read_page(right_ptr)?;
                    self.visited_pages.push(right_ptr);
                    self.page_stack.push((right_page, 0));
                    continue;
                }
                
                // No right pointer, pop this page and continue with parent
                self.page_stack.pop();
                continue;
            }
            
            // Process the current cell in the interior page
            let is_first_page = page.page_number == 1;
            let cell_pointers = match page.cell_pointers(is_first_page) {
                Ok(pointers) => pointers,
                Err(e) => {
                    log_warn(&format!("Failed to get cell pointers for interior page {}: {}", page.page_number, e));
                    // Skip this page and continue with parent
                    self.page_stack.pop();
                    continue;
                }
            };
            
            if *cell_index >= cell_pointers.len() {
                // Pop this page and continue with parent
                self.page_stack.pop();
                continue;
            }
            
            let cell_offset = cell_pointers[*cell_index];
            let cell_data = match page.cell_content(cell_offset) {
                Ok(data) => data,
                Err(e) => {
                    log_warn(&format!("Failed to get cell content at offset {} on interior page {}: {}", cell_offset, page.page_number, e));
                    // Skip this cell and move to next
                    *cell_index += 1;
                    continue;
                }
            };
            
            // Parse the interior cell
            let cell = match parse_interior_table_cell(cell_data) {
                Ok(cell) => cell,
                Err(e) => {
                    log_warn(&format!("Failed to parse interior cell on page {}: {}", page.page_number, e));
                    // Skip this cell and move to next
                    *cell_index += 1;
                    continue;
                }
            };

            // Move to next cell in this interior page for the next iteration
            *cell_index += 1;

            // Descend to the left child of this interior cell
            if let Some(left_child) = cell.left_child {
                // Prevent revisiting pages and potential infinite loops
                if !self.visited_pages.contains(&left_child) {
                    let child_page = match read_page(left_child) {
                        Ok(p) => p,
                        Err(e) => {
                            log_warn(&format!("Failed to read child page {}: {}", left_child, e));
                            continue;
                        }
                    };
                    self.visited_pages.push(left_child);
                    self.page_stack.push((child_page, 0));
                }
            }

            // Continue traversal with the newly pushed page (if any)
            continue;
        }
    }

    /// Find all rowids for a composite index key (exact match on all components).
    pub fn find_rowids_by_key<F>(&mut self, key: &[&Value], mut read_page: F) -> Result<Vec<i64>>
    where
        F: FnMut(u32) -> Result<Page>,
    {
        log_debug(&format!("[BTreeCursor] Searching for composite key: {:?}", key));
        if self.page_stack.is_empty() {
            return Ok(Vec::new());
        }

        let root_page_num = self.page_stack[0].0.page_number;
        let mut current_page = read_page(root_page_num)?;

        // Descend until we hit a leaf page in the index B-tree
        loop {
            if current_page.page_type.is_leaf() {
                break;
            }

            let cell_pointers = current_page.cell_pointers(current_page.page_number == 1)?;
            // By default, follow the right-most child ( > all keys )
            let mut next_page_num = current_page
                .right_pointer
                .ok_or_else(|| Error::InvalidFormat("Interior index page missing right pointer".into()))?;

            // Iterate over cells to find the first key >= search key (lexicographically by component)
            for &cell_offset in &cell_pointers {
                let cell_data = current_page.cell_content(cell_offset)?;
                let cell = parse_interior_index_cell(&cell_data)?;
                let cell_key_refs: Vec<&Value> = cell.key.iter().collect();

                let cmp_len = std::cmp::min(key.len(), cell_key_refs.len());
                let ord = key[..cmp_len].cmp(&cell_key_refs[..cmp_len]);
                if ord == std::cmp::Ordering::Less || ord == std::cmp::Ordering::Equal {
                    next_page_num = cell.left_child;
                    break;
                }
            }

            current_page = read_page(next_page_num)?;
        }

        // We're now on a leaf page – gather all rowids whose key matches exactly
        let mut rowids = Vec::new();
        let cell_pointers = current_page.cell_pointers(current_page.page_number == 1)?;
        
        for &cell_offset in &cell_pointers {
            let cell_data = current_page.cell_content(cell_offset)?;
            let cell = parse_leaf_index_cell(&cell_data)?;

            // Need at least as many components as the search key
            if cell.key.len() < key.len() {
                continue;
            }
            
            // Exact component-wise equality for the prefix length of key
            let matches = cell
                .key
                .iter()
                .zip(key.iter())
                .all(|(a, b)| a == *b);
            
            log_debug(&format!(
                "[BTreeCursor] Checking cell: key={:?} vs search={:?}, matches={}",
                cell.key, key, matches
            ));
            
            if matches {
                log_debug(&format!("[BTreeCursor] MATCH FOUND! Adding rowid {}", cell.rowid));
                rowids.push(cell.rowid);
            } else {
                // Check if we've passed the search key alphabetically
                // Since the page is sorted, if the current cell key is greater than the search key,
                // no further cells will match
                if let (Some(search_first), Some(cell_first)) = (key.first(), cell.key.first()) {
                    match cell_first.cmp(search_first) {
                        std::cmp::Ordering::Greater => {
                            // We've passed the search key, stop searching
                            log_debug(&format!(
                                "[BTreeCursor] Cell key {:?} > search key {:?}, stopping early scan on page {}",
                                cell.key, key, current_page.page_number
                            ));
                            break;
                        },
                        std::cmp::Ordering::Less => {
                            // Cell key is less than search key, continue searching
                            log_debug(&format!(
                                "[BTreeCursor] Cell key {:?} < search key {:?}, continuing search",
                                cell.key, key
                            ));
                        },
                        std::cmp::Ordering::Equal => {
                            // First component matches but full key doesn't - could be composite key mismatch
                            log_debug(&format!(
                                "[BTreeCursor] Partial composite key mismatch – cell key {:?} vs search {:?}",
                                cell.key, key
                            ));
                        }
                    }
                }
            }
        }

        log_debug(&format!(
            "[BTreeCursor] Composite key search found {} rowids", rowids.len()
        ));
        Ok(rowids)
    }

}

/// Parse a leaf table cell
fn parse_leaf_table_cell(data: &[u8]) -> Result<Cell> {
    let (payload_size, offset) = read_varint(data)?;
    let (rowid, offset2) = read_varint(&data[offset..])?;
    let offset = offset + offset2;
    
    // Add bounds checking to prevent panic
    let payload_end = offset + payload_size as usize;
    if payload_end > data.len() {
        return Err(Error::InvalidFormat(format!(
            "Payload size {} exceeds available data (offset: {}, data_len: {})",
            payload_size, offset, data.len()
        )));
    }
    
    let payload = data[offset..payload_end].to_vec();
    
    Ok(Cell {
        left_child: None,
        key: rowid,
        payload,
    })
}

/// Parse an interior table cell
fn parse_interior_table_cell(data: &[u8]) -> Result<Cell> {
    // Check if we have enough data for the left child pointer
    if data.len() < 4 {
        return Err(Error::InvalidFormat(format!(
            "Interior cell data too short: {} bytes, need at least 4",
            data.len()
        )));
    }
    
    let left_child = u32::from_be_bytes([data[0], data[1], data[2], data[3]]);
    let (rowid, _) = read_varint(&data[4..])?;
    
    Ok(Cell {
        left_child: Some(left_child),
        key: rowid,
        payload: Vec::new(),
    })
}

/// Parse a leaf index cell
fn parse_leaf_index_cell(data: &[u8]) -> Result<IndexCell> {
    let (payload_size, offset) = read_varint(data)?;
    let payload = &data[offset..offset + payload_size as usize];
    let (header_size, mut header_offset) = read_varint(payload)?;
    let mut values = Vec::new();
    let mut content_offset = header_size as usize;

    while header_offset < header_size as usize {
        let (serial_type, bytes_read) = read_varint(&payload[header_offset..])?;
        header_offset += bytes_read;
        let (value, value_bytes) = crate::record::parse_value(serial_type, &payload[content_offset..])?;
        values.push(value);
        content_offset += value_bytes;
    }

    // In SQLite index leaf cells, the ROWID is the last value in the payload
    // Extract it from the values array
    if values.is_empty() {
        return Err(Error::InvalidFormat("Index cell has no values".into()));
    }
    
    let rowid = match values.pop().unwrap() {
        Value::Integer(id) => id,
        _ => return Err(Error::InvalidFormat("Index cell ROWID is not an integer".into())),
    };

    Ok(IndexCell { key: values, rowid })
}

/// Parse an interior index cell
fn parse_interior_index_cell(data: &[u8]) -> Result<InteriorIndexCell> {
    let left_child = u32::from_be_bytes([data[0], data[1], data[2], data[3]]);
    let (payload_size, offset) = read_varint(&data[4..])?;
    let payload = &data[4 + offset..4 + offset + payload_size as usize];
    let (header_size, mut header_offset) = read_varint(payload)?;
    let mut values = Vec::new();
    let mut content_offset = header_size as usize;

    while header_offset < header_size as usize {
        let (serial_type, bytes_read) = read_varint(&payload[header_offset..])?;
        header_offset += bytes_read;
        let (value, value_bytes) = crate::record::parse_value(serial_type, &payload[content_offset..])?;
        values.push(value);
        content_offset += value_bytes;
    }

    Ok(InteriorIndexCell {
        left_child,
        key: values,
    })
}

/// Read a variable-length integer
pub fn read_varint(data: &[u8]) -> Result<(i64, usize)> {
    let mut value = 0i64;
    let mut offset = 0;
    
    for i in 0..9 {
        if offset >= data.len() {
            return Err(Error::InvalidVarint);
        }
        
        let byte = data[offset];
        offset += 1;
        
        if i < 8 {
            value = (value << 7) | ((byte & 0x7f) as i64);
            if byte < 0x80 {
                return Ok((value, offset));
            }
        } else {
            value = (value << 8) | (byte as i64);
            return Ok((value, offset));
        }
    }
    
    Err(Error::InvalidVarint)
}