Skip to main content

fsqlite_types/
opcode.rs

1/// VDBE (Virtual Database Engine) opcodes.
2///
3/// These correspond 1:1 to the upstream SQLite VDBE opcode set. Each opcode
4/// represents a single operation in the bytecode program that the VDBE
5/// executes. Opcodes are numbered sequentially; the specific numeric values
6/// match C SQLite for debugging/comparison purposes.
7///
8/// Reference: canonical upstream SQLite opcode definitions.
9#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
10#[repr(u8)]
11#[allow(clippy::enum_variant_names)]
12pub enum Opcode {
13    // === Control Flow ===
14    /// Jump to address P2.
15    Goto = 1,
16    /// Push return address, jump to P2.
17    Gosub = 2,
18    /// Pop return address, jump to it.
19    Return = 3,
20    /// Initialize coroutine. P1=coroutine reg, P2=jump on first entry.
21    InitCoroutine = 4,
22    /// End coroutine, jump to return address.
23    EndCoroutine = 5,
24    /// Yield control to/from coroutine.
25    Yield = 6,
26    /// Halt if register P3 is NULL.
27    HaltIfNull = 7,
28    /// Halt execution (with optional error).
29    Halt = 8,
30
31    // === Constants & Values ===
32    /// Set register P2 to integer value P1.
33    Integer = 9,
34    /// Set register P2 to 64-bit integer from P4.
35    Int64 = 10,
36    /// Set register P2 to real value from P4.
37    Real = 11,
38    /// Set register P2 to string P4 (zero-terminated).
39    String8 = 12,
40    /// Set register P2 to string of length P1 from P4.
41    String = 13,
42    /// Begin subroutine / set register P2 to NULL.
43    BeginSubrtn = 14,
44    /// Set registers P2..P2+P3-1 to NULL.
45    Null = 15,
46    /// Set register to soft NULL (for optimization).
47    SoftNull = 16,
48    /// Set register P2 to blob of length P1 from P4.
49    Blob = 17,
50    /// Set register P2 to the value of variable/parameter P1.
51    Variable = 18,
52
53    // === Register Operations ===
54    /// Move P3 registers from P1 to P2.
55    Move = 19,
56    /// Copy register P1 to P2 (and optionally more).
57    Copy = 20,
58    /// Shallow copy register P1 to P2.
59    SCopy = 21,
60    /// Copy integer value from P1 to P2.
61    IntCopy = 22,
62
63    // === Foreign Key ===
64    /// Check foreign key constraints.
65    FkCheck = 23,
66
67    // === Result ===
68    /// Output a row of P2 registers starting at P1.
69    ResultRow = 24,
70
71    // === Arithmetic & String ===
72    /// Concatenate P1 and P2, store in P3.
73    Concat = 25,
74    /// P3 = P2 + P1.
75    Add = 26,
76    /// P3 = P2 - P1.
77    Subtract = 27,
78    /// P3 = P2 * P1.
79    Multiply = 28,
80    /// P3 = P2 / P1.
81    Divide = 29,
82    /// P3 = P2 % P1.
83    Remainder = 30,
84
85    // === Collation ===
86    /// Set collation sequence for comparison.
87    CollSeq = 31,
88
89    // === Bitwise ===
90    /// P3 = P1 & P2.
91    BitAnd = 32,
92    /// P3 = P1 | P2.
93    BitOr = 33,
94    /// P3 = P2 << P1.
95    ShiftLeft = 34,
96    /// P3 = P2 >> P1.
97    ShiftRight = 35,
98
99    // === Type Conversion ===
100    /// Add integer P2 to register P1.
101    AddImm = 36,
102    /// Fail if P1 is not an integer; optionally jump to P2.
103    MustBeInt = 37,
104    /// If P1 is integer, convert to real in-place.
105    RealAffinity = 38,
106    /// Cast register P1 to type P2.
107    Cast = 39,
108
109    // === Comparison ===
110    /// Jump to P2 if P1 == P3.
111    Eq = 40,
112    /// Jump to P2 if P1 != P3.
113    Ne = 41,
114    /// Jump to P2 if P3 < P1.
115    Lt = 42,
116    /// Jump to P2 if P3 <= P1.
117    Le = 43,
118    /// Jump to P2 if P3 > P1.
119    Gt = 44,
120    /// Jump to P2 if P3 >= P1.
121    Ge = 45,
122    /// Jump if the previous comparison was Eq (for multi-column indexes).
123    ElseEq = 46,
124
125    // === Permutation & Compare ===
126    /// Set up permutation for subsequent Compare.
127    Permutation = 47,
128    /// Compare P1..P1+P3-1 with P2..P2+P3-1.
129    Compare = 48,
130
131    // === Branching ===
132    /// Jump to one of P1, P2, or P3 based on comparison result.
133    Jump = 49,
134    /// P3 = P1 AND P2 (three-valued logic).
135    And = 50,
136    /// P3 = P1 OR P2 (three-valued logic).
137    Or = 51,
138    /// Apply IS TRUE test.
139    IsTrue = 52,
140    /// P2 = NOT P1.
141    Not = 53,
142    /// P2 = ~P1 (bitwise not).
143    BitNot = 54,
144    /// Jump to P2 on first execution only.
145    Once = 55,
146    /// Jump to P2 if P1 is true (non-zero and non-NULL).
147    If = 56,
148    /// Jump to P2 if P1 is false (zero or NULL).
149    IfNot = 57,
150    /// Jump to P2 if P1 is NULL.
151    IsNull = 58,
152    /// Type check against P5 type mask; jump to P2 on mismatch.
153    IsType = 59,
154    /// P2 = 0 if any of P1, P2, P3 is NULL.
155    ZeroOrNull = 60,
156    /// Jump to P2 if P1 is not NULL.
157    NotNull = 61,
158    /// Jump to P2 if the current row of cursor P1 is NULL.
159    IfNullRow = 62,
160
161    // === Column Access ===
162    /// Extract byte offset of cursor.
163    Offset = 63,
164    /// Extract column P2 from cursor P1 into register P3.
165    Column = 64,
166    /// Type-check columns against declared types.
167    TypeCheck = 65,
168    /// Apply type affinity to P2 registers starting at P1.
169    Affinity = 66,
170
171    // === Record Building ===
172    /// Build a record from P1..P1+P2-1 registers into P3.
173    MakeRecord = 67,
174
175    // === Counting ===
176    /// Store the number of rows in cursor P1 into register P2.
177    Count = 68,
178
179    // === Transaction Control ===
180    /// Begin, release, or rollback a savepoint.
181    Savepoint = 69,
182    /// Set or clear auto-commit mode.
183    AutoCommit = 70,
184    /// Begin a transaction on database P1.
185    Transaction = 71,
186
187    // === Cookie Access ===
188    /// Read database cookie P3 from database P1 into register P2.
189    ReadCookie = 72,
190    /// Write P3 to database cookie P2 of database P1.
191    SetCookie = 73,
192
193    // === Cursor Operations ===
194    /// Reopen an index cursor (P1) if it's on a different root page.
195    ReopenIdx = 74,
196    /// Open a read cursor on table/index P2 in database P3.
197    OpenRead = 75,
198    /// Open a write cursor on table/index P2 in database P3.
199    OpenWrite = 76,
200    /// Open cursor P1 as a duplicate of cursor P2.
201    OpenDup = 77,
202    /// Open an ephemeral (temporary) table cursor.
203    OpenEphemeral = 78,
204    /// Open an auto-index ephemeral cursor.
205    OpenAutoindex = 79,
206    /// Open a sorter cursor.
207    SorterOpen = 80,
208    /// Test if sequence number has been used.
209    SequenceTest = 81,
210    /// Open a pseudo-table cursor (reads from a register).
211    OpenPseudo = 82,
212    /// Close cursor P1.
213    Close = 83,
214    /// Set the columns-used mask for cursor P1.
215    ColumnsUsed = 84,
216
217    // === Seek Operations ===
218    /// Seek cursor P1 to the largest entry less than P3.
219    SeekLT = 85,
220    /// Seek cursor P1 to the largest entry <= P3.
221    SeekLE = 86,
222    /// Seek cursor P1 to the smallest entry >= P3.
223    SeekGE = 87,
224    /// Seek cursor P1 to the smallest entry greater than P3.
225    SeekGT = 88,
226    /// Optimized seek-scan for small result sets.
227    SeekScan = 89,
228    /// Mark seek hit range for covering index optimization.
229    SeekHit = 90,
230    /// Jump to P2 if cursor P1 is not open.
231    IfNotOpen = 91,
232
233    // === Index Lookup ===
234    /// Like NotFound but with Bloom filter check.
235    IfNoHope = 92,
236    /// Jump to P2 if key P3 is NOT found (no conflict).
237    NoConflict = 93,
238    /// Jump to P2 if key P3 is NOT found in cursor P1.
239    NotFound = 94,
240    /// Jump to P2 if key P3 IS found in cursor P1.
241    Found = 95,
242
243    // === Rowid Seek ===
244    /// Seek cursor P1 to rowid P3; jump to P2 if not found.
245    SeekRowid = 96,
246    /// Jump to P2 if rowid P3 does NOT exist in cursor P1.
247    NotExists = 97,
248
249    // === Sequence & Rowid ===
250    /// Store next sequence value for cursor P1 into register P2.
251    Sequence = 98,
252    /// Generate a new unique rowid for cursor P1.
253    NewRowid = 99,
254
255    // === Insert & Delete ===
256    /// Insert record from P2 with rowid P3 into cursor P1.
257    Insert = 100,
258    /// Copy a cell directly from one cursor to another.
259    RowCell = 101,
260    /// Delete the current row of cursor P1.
261    Delete = 102,
262    /// Reset the change counter.
263    ResetCount = 103,
264
265    // === Sorter Operations ===
266    /// Compare sorter key.
267    SorterCompare = 104,
268    /// Read data from the sorter.
269    SorterData = 105,
270
271    // === Row Data ===
272    /// Copy the complete row data of cursor P1 into register P2.
273    RowData = 106,
274    /// Store the rowid of cursor P1 into register P2.
275    Rowid = 107,
276    /// Set cursor P1 to a NULL row.
277    NullRow = 108,
278
279    // === Cursor Navigation ===
280    /// Seek to end of table (no-op for reading, positions for append).
281    SeekEnd = 109,
282    /// Move cursor P1 to the last entry; jump to P2 if empty.
283    Last = 110,
284    /// Jump to P2 if table size is between P3 and P4.
285    IfSizeBetween = 111,
286    /// Sort (alias for SorterSort in some contexts).
287    SorterSort = 112,
288    /// Sort cursor P1.
289    Sort = 113,
290    /// Rewind cursor P1 to the first entry; jump to P2 if empty.
291    Rewind = 114,
292    /// Jump to P2 if cursor P1's table is empty.
293    IfEmpty = 115,
294
295    // === Iteration ===
296    /// Advance sorter to next entry.
297    SorterNext = 116,
298    /// Move cursor P1 to the previous entry; jump to P2 if done.
299    Prev = 117,
300    /// Move cursor P1 to the next entry; jump to P2 if done.
301    Next = 118,
302
303    // === Index Insert/Delete ===
304    /// Insert record P2 into index cursor P1.
305    IdxInsert = 119,
306    /// Insert into sorter.
307    SorterInsert = 120,
308    /// Delete from index cursor P1.
309    IdxDelete = 121,
310
311    // === Deferred Seek ===
312    /// Defer a seek on cursor P1 using the rowid from index cursor P2.
313    DeferredSeek = 122,
314    /// Extract rowid from index entry of cursor P1.
315    IdxRowid = 123,
316    /// Complete a previously deferred seek.
317    FinishSeek = 124,
318
319    // === Index Comparison ===
320    /// Jump to P2 if index key of P1 <= key.
321    IdxLE = 125,
322    /// Jump to P2 if index key of P1 > key.
323    IdxGT = 126,
324    /// Jump to P2 if index key of P1 < key.
325    IdxLT = 127,
326    /// Jump to P2 if index key of P1 >= key.
327    IdxGE = 128,
328
329    // === DDL Operations ===
330    /// Destroy (drop) a B-tree rooted at page P1.
331    Destroy = 129,
332    /// Clear (delete all rows from) a table or index.
333    Clear = 130,
334    /// Reset a sorter cursor.
335    ResetSorter = 131,
336    /// Allocate a new B-tree, store root page number in P2.
337    CreateBtree = 132,
338
339    // === Schema Operations ===
340    /// Execute an SQL statement stored in P4.
341    SqlExec = 133,
342    /// Parse the schema for database P1.
343    ParseSchema = 134,
344    /// Load analysis data for database P1.
345    LoadAnalysis = 135,
346    /// Drop a table.
347    DropTable = 136,
348    /// Drop an index.
349    DropIndex = 137,
350    /// Drop a trigger.
351    DropTrigger = 138,
352
353    // === Integrity Check ===
354    /// Run integrity check on database P1.
355    IntegrityCk = 139,
356
357    // === RowSet Operations ===
358    /// Add integer P2 to rowset P1.
359    RowSetAdd = 140,
360    /// Read next value from rowset P1 into P3; jump to P2 when empty.
361    RowSetRead = 141,
362    /// Test if P3 exists in rowset P1; jump to P2 if found.
363    RowSetTest = 142,
364
365    // === Trigger/Program ===
366    /// Call a trigger sub-program.
367    Program = 143,
368    /// Copy trigger parameter into register P2.
369    Param = 144,
370
371    // === FK Counters ===
372    /// Increment or decrement FK counter.
373    FkCounter = 145,
374    /// Jump to P2 if FK counter is zero.
375    FkIfZero = 146,
376
377    // === Memory/Counter ===
378    /// Set register P2 to max of P2 and register P1.
379    MemMax = 147,
380
381    // === Conditional Jumps ===
382    /// Jump to P2 if register P1 > 0; decrement by P3.
383    IfPos = 148,
384    /// Compute offset limit.
385    OffsetLimit = 149,
386    /// Jump to P2 if register P1 is not zero.
387    IfNotZero = 150,
388    /// Decrement P1, jump to P2 if result is zero.
389    DecrJumpZero = 151,
390
391    // === Aggregate Functions ===
392    /// Invoke aggregate inverse function.
393    AggInverse = 152,
394    /// Invoke aggregate step function.
395    AggStep = 153,
396    /// Step variant with different init semantics.
397    AggStep1 = 154,
398    /// Extract aggregate intermediate value.
399    AggValue = 155,
400    /// Finalize aggregate function.
401    AggFinal = 156,
402
403    // === WAL & Journal ===
404    /// Checkpoint the WAL for database P1.
405    Checkpoint = 157,
406    /// Set journal mode for database P1.
407    JournalMode = 158,
408
409    // === Vacuum ===
410    /// Vacuum the database.
411    Vacuum = 159,
412    /// Incremental vacuum step; jump to P2 if done.
413    IncrVacuum = 160,
414
415    // === Expiry & Locking ===
416    /// Mark prepared statement as expired.
417    Expire = 161,
418    /// Lock cursor P1.
419    CursorLock = 162,
420    /// Unlock cursor P1.
421    CursorUnlock = 163,
422    /// Lock table P2 in database P1.
423    TableLock = 164,
424
425    // === Virtual Table ===
426    /// Begin a virtual table transaction.
427    VBegin = 165,
428    /// Create a virtual table.
429    VCreate = 166,
430    /// Destroy a virtual table.
431    VDestroy = 167,
432    /// Open a virtual table cursor.
433    VOpen = 168,
434    /// Check virtual table integrity.
435    VCheck = 169,
436    /// Initialize IN constraint for virtual table.
437    VInitIn = 170,
438    /// Apply filter to virtual table cursor.
439    VFilter = 171,
440    /// Read column from virtual table cursor.
441    VColumn = 172,
442    /// Advance virtual table cursor.
443    VNext = 173,
444    /// Rename a virtual table.
445    VRename = 174,
446    /// Update/insert/delete on virtual table.
447    VUpdate = 175,
448
449    // === Page Count ===
450    /// Store database page count in register P2.
451    Pagecount = 176,
452    /// Set or read max page count.
453    MaxPgcnt = 177,
454
455    // === Functions ===
456    /// Call a pure (deterministic) function.
457    PureFunc = 178,
458    /// Call a function (possibly with side effects).
459    Function = 179,
460
461    // === Subtype Operations ===
462    /// Clear the subtype from register P1.
463    ClrSubtype = 180,
464    /// Get subtype of P1 into P2.
465    GetSubtype = 181,
466    /// Set subtype of P2 from P1.
467    SetSubtype = 182,
468
469    // === Bloom Filter ===
470    /// Add entry to Bloom filter.
471    FilterAdd = 183,
472    /// Test Bloom filter; jump to P2 if definitely not present.
473    Filter = 184,
474
475    // === Trace & Init ===
476    /// Trace/profile callback.
477    Trace = 185,
478    /// Initialize VDBE program; jump to P2.
479    Init = 186,
480
481    // === Hints & Debug ===
482    /// Provide cursor hint to storage engine.
483    CursorHint = 187,
484    /// Mark that this program can be aborted.
485    Abortable = 188,
486    /// Release register range.
487    ReleaseReg = 189,
488
489    // === Time-travel (SQL:2011 temporal queries) ===
490    /// Set time-travel snapshot on cursor P1.
491    /// P4 carries `TimeTravelCommitSeq(n)` or `TimeTravelTimestamp(ts)`.
492    /// Must immediately follow the `OpenRead` for the same cursor.
493    /// The cursor becomes read-only; DML/DDL through it returns an error.
494    SetSnapshot = 190,
495
496    // === Noop & FrankenSQLite extensions ===
497    /// No operation.
498    Noop = 191,
499    /// Evaluate a literal-pattern LIKE fast path directly against a register.
500    LikeConstFast = 192,
501    /// Count a run of equal first-column index keys, advancing the cursor.
502    CountIndexEqRun = 193,
503
504    // === Superinstructions (bd-perf V2.1) ===
505    /// Fused NewRowid + MakeRecord + Insert for sequential append.
506    ///
507    /// P1 = cursor number
508    /// P2 = first register of column values (same as MakeRecord P1)
509    /// P3 = number of columns (same as MakeRecord P2)
510    /// P5 = Insert flags (OE_* conflict mode in low nibble)
511    ///
512    /// Combines three opcodes into one dispatch:
513    /// 1. Allocate next sequential rowid (using cached last_alloc_rowid)
514    /// 2. Serialize column registers into record blob
515    /// 3. Append to B-tree via table_insert (prechecked absent, append mode)
516    ///
517    /// Guard conditions (codegen must verify before emitting):
518    /// - No secondary indexes on the table
519    /// - No triggers
520    /// - No foreign keys
521    /// - Default ABORT conflict mode (OE_ABORT = 2 in low nibble)
522    /// - No generated/stored columns
523    FusedAppendInsert = 194,
524
525    /// Fused OpenWrite + Last for cursor setup in INSERT programs.
526    /// P1 = cursor, P2 = root page number, P3 = column count, P5 = flags.
527    /// Opens a write cursor and navigates to the last entry for append.
528    FusedOpenWriteLast = 195,
529
530    /// Fused `Integer(p1=lit, p2=reg) + ResultRow(p1=reg, p2=1)` pair.
531    ///
532    /// Emits a single-column result row whose only value is the literal
533    /// integer `p1`, then clears register `p2` (matching the post-`ResultRow`
534    /// side effect of `take_reg_range`, which drains the source register).
535    ///
536    /// P1 = integer literal value
537    /// P2 = source register (written with the literal, then consumed)
538    /// P3 = unused (reserved; must be 0)
539    /// P4 = `P4::None`
540    /// P5 = 0
541    ///
542    /// Correctness contract: byte-equivalent to the unfused pair. Only the
543    /// peephole codegen pass emits this opcode; it MUST verify that the
544    /// immediately-following `ResultRow` consumes exactly the register
545    /// written by `Integer` and outputs exactly one column.
546    FusedLiteralResultRow = 196,
547
548    /// Compute `SUBSTR(column, 1, P4)` directly from a table cursor column.
549    ///
550    /// P1 = cursor number, P2 = logical column index, P3 = output register,
551    /// P4 = `Int(prefix_len)`, P5 = 0.
552    ///
553    /// The engine may fast-path storage TEXT/BLOB payload prefixes without
554    /// materializing the full column. Unsupported storage classes fall back to
555    /// the equivalent scalar `substr(value, 1, prefix_len)` behavior.
556    ColumnSubstrPrefix = 197,
557}
558
559impl Opcode {
560    /// Total number of opcodes defined.
561    pub const COUNT: usize = 198;
562
563    /// Get the opcode name as a static string slice.
564    #[allow(clippy::too_many_lines)]
565    pub const fn name(self) -> &'static str {
566        match self {
567            Self::Goto => "Goto",
568            Self::Gosub => "Gosub",
569            Self::Return => "Return",
570            Self::InitCoroutine => "InitCoroutine",
571            Self::EndCoroutine => "EndCoroutine",
572            Self::Yield => "Yield",
573            Self::HaltIfNull => "HaltIfNull",
574            Self::Halt => "Halt",
575            Self::Integer => "Integer",
576            Self::Int64 => "Int64",
577            Self::Real => "Real",
578            Self::String8 => "String8",
579            Self::String => "String",
580            Self::BeginSubrtn => "BeginSubrtn",
581            Self::Null => "Null",
582            Self::SoftNull => "SoftNull",
583            Self::Blob => "Blob",
584            Self::Variable => "Variable",
585            Self::Move => "Move",
586            Self::Copy => "Copy",
587            Self::SCopy => "SCopy",
588            Self::IntCopy => "IntCopy",
589            Self::FkCheck => "FkCheck",
590            Self::ResultRow => "ResultRow",
591            Self::Concat => "Concat",
592            Self::Add => "Add",
593            Self::Subtract => "Subtract",
594            Self::Multiply => "Multiply",
595            Self::Divide => "Divide",
596            Self::Remainder => "Remainder",
597            Self::CollSeq => "CollSeq",
598            Self::BitAnd => "BitAnd",
599            Self::BitOr => "BitOr",
600            Self::ShiftLeft => "ShiftLeft",
601            Self::ShiftRight => "ShiftRight",
602            Self::AddImm => "AddImm",
603            Self::MustBeInt => "MustBeInt",
604            Self::RealAffinity => "RealAffinity",
605            Self::Cast => "Cast",
606            Self::Eq => "Eq",
607            Self::Ne => "Ne",
608            Self::Lt => "Lt",
609            Self::Le => "Le",
610            Self::Gt => "Gt",
611            Self::Ge => "Ge",
612            Self::ElseEq => "ElseEq",
613            Self::Permutation => "Permutation",
614            Self::Compare => "Compare",
615            Self::Jump => "Jump",
616            Self::And => "And",
617            Self::Or => "Or",
618            Self::IsTrue => "IsTrue",
619            Self::Not => "Not",
620            Self::BitNot => "BitNot",
621            Self::Once => "Once",
622            Self::If => "If",
623            Self::IfNot => "IfNot",
624            Self::IsNull => "IsNull",
625            Self::IsType => "IsType",
626            Self::ZeroOrNull => "ZeroOrNull",
627            Self::NotNull => "NotNull",
628            Self::IfNullRow => "IfNullRow",
629            Self::Offset => "Offset",
630            Self::Column => "Column",
631            Self::TypeCheck => "TypeCheck",
632            Self::Affinity => "Affinity",
633            Self::MakeRecord => "MakeRecord",
634            Self::Count => "Count",
635            Self::Savepoint => "Savepoint",
636            Self::AutoCommit => "AutoCommit",
637            Self::Transaction => "Transaction",
638            Self::ReadCookie => "ReadCookie",
639            Self::SetCookie => "SetCookie",
640            Self::ReopenIdx => "ReopenIdx",
641            Self::OpenRead => "OpenRead",
642            Self::OpenWrite => "OpenWrite",
643            Self::OpenDup => "OpenDup",
644            Self::OpenEphemeral => "OpenEphemeral",
645            Self::OpenAutoindex => "OpenAutoindex",
646            Self::SorterOpen => "SorterOpen",
647            Self::SequenceTest => "SequenceTest",
648            Self::OpenPseudo => "OpenPseudo",
649            Self::Close => "Close",
650            Self::ColumnsUsed => "ColumnsUsed",
651            Self::SeekLT => "SeekLT",
652            Self::SeekLE => "SeekLE",
653            Self::SeekGE => "SeekGE",
654            Self::SeekGT => "SeekGT",
655            Self::SeekScan => "SeekScan",
656            Self::SeekHit => "SeekHit",
657            Self::IfNotOpen => "IfNotOpen",
658            Self::IfNoHope => "IfNoHope",
659            Self::NoConflict => "NoConflict",
660            Self::NotFound => "NotFound",
661            Self::Found => "Found",
662            Self::SeekRowid => "SeekRowid",
663            Self::NotExists => "NotExists",
664            Self::Sequence => "Sequence",
665            Self::NewRowid => "NewRowid",
666            Self::Insert => "Insert",
667            Self::RowCell => "RowCell",
668            Self::Delete => "Delete",
669            Self::ResetCount => "ResetCount",
670            Self::SorterCompare => "SorterCompare",
671            Self::SorterData => "SorterData",
672            Self::RowData => "RowData",
673            Self::Rowid => "Rowid",
674            Self::NullRow => "NullRow",
675            Self::SeekEnd => "SeekEnd",
676            Self::Last => "Last",
677            Self::IfSizeBetween => "IfSizeBetween",
678            Self::SorterSort => "SorterSort",
679            Self::Sort => "Sort",
680            Self::Rewind => "Rewind",
681            Self::IfEmpty => "IfEmpty",
682            Self::SorterNext => "SorterNext",
683            Self::Prev => "Prev",
684            Self::Next => "Next",
685            Self::IdxInsert => "IdxInsert",
686            Self::SorterInsert => "SorterInsert",
687            Self::IdxDelete => "IdxDelete",
688            Self::DeferredSeek => "DeferredSeek",
689            Self::IdxRowid => "IdxRowid",
690            Self::FinishSeek => "FinishSeek",
691            Self::IdxLE => "IdxLE",
692            Self::IdxGT => "IdxGT",
693            Self::IdxLT => "IdxLT",
694            Self::IdxGE => "IdxGE",
695            Self::Destroy => "Destroy",
696            Self::Clear => "Clear",
697            Self::ResetSorter => "ResetSorter",
698            Self::CreateBtree => "CreateBtree",
699            Self::SqlExec => "SqlExec",
700            Self::ParseSchema => "ParseSchema",
701            Self::LoadAnalysis => "LoadAnalysis",
702            Self::DropTable => "DropTable",
703            Self::DropIndex => "DropIndex",
704            Self::DropTrigger => "DropTrigger",
705            Self::IntegrityCk => "IntegrityCk",
706            Self::RowSetAdd => "RowSetAdd",
707            Self::RowSetRead => "RowSetRead",
708            Self::RowSetTest => "RowSetTest",
709            Self::Program => "Program",
710            Self::Param => "Param",
711            Self::FkCounter => "FkCounter",
712            Self::FkIfZero => "FkIfZero",
713            Self::MemMax => "MemMax",
714            Self::IfPos => "IfPos",
715            Self::OffsetLimit => "OffsetLimit",
716            Self::IfNotZero => "IfNotZero",
717            Self::DecrJumpZero => "DecrJumpZero",
718            Self::AggInverse => "AggInverse",
719            Self::AggStep => "AggStep",
720            Self::AggStep1 => "AggStep1",
721            Self::AggValue => "AggValue",
722            Self::AggFinal => "AggFinal",
723            Self::Checkpoint => "Checkpoint",
724            Self::JournalMode => "JournalMode",
725            Self::Vacuum => "Vacuum",
726            Self::IncrVacuum => "IncrVacuum",
727            Self::Expire => "Expire",
728            Self::CursorLock => "CursorLock",
729            Self::CursorUnlock => "CursorUnlock",
730            Self::TableLock => "TableLock",
731            Self::VBegin => "VBegin",
732            Self::VCreate => "VCreate",
733            Self::VDestroy => "VDestroy",
734            Self::VOpen => "VOpen",
735            Self::VCheck => "VCheck",
736            Self::VInitIn => "VInitIn",
737            Self::VFilter => "VFilter",
738            Self::VColumn => "VColumn",
739            Self::VNext => "VNext",
740            Self::VRename => "VRename",
741            Self::VUpdate => "VUpdate",
742            Self::Pagecount => "Pagecount",
743            Self::MaxPgcnt => "MaxPgcnt",
744            Self::PureFunc => "PureFunc",
745            Self::Function => "Function",
746            Self::ClrSubtype => "ClrSubtype",
747            Self::GetSubtype => "GetSubtype",
748            Self::SetSubtype => "SetSubtype",
749            Self::FilterAdd => "FilterAdd",
750            Self::Filter => "Filter",
751            Self::Trace => "Trace",
752            Self::Init => "Init",
753            Self::CursorHint => "CursorHint",
754            Self::Abortable => "Abortable",
755            Self::ReleaseReg => "ReleaseReg",
756            Self::SetSnapshot => "SetSnapshot",
757            Self::Noop => "Noop",
758            Self::LikeConstFast => "LikeConstFast",
759            Self::CountIndexEqRun => "CountIndexEqRun",
760            Self::FusedAppendInsert => "FusedAppendInsert",
761            Self::FusedOpenWriteLast => "FusedOpenWriteLast",
762            Self::FusedLiteralResultRow => "FusedLiteralResultRow",
763            Self::ColumnSubstrPrefix => "ColumnSubstrPrefix",
764        }
765    }
766
767    /// Try to convert a u8 to an Opcode.
768    #[allow(clippy::too_many_lines)]
769    pub const fn from_byte(byte: u8) -> Option<Self> {
770        if byte == 0 || byte as usize >= Self::COUNT {
771            return None;
772        }
773        // SAFETY: All values 1..Opcode::COUNT are valid discriminants.
774        // We verified byte is in range above.
775        // Since the enum is repr(u8) with consecutive values, this is safe.
776        // However, since unsafe is forbidden, we use a match instead.
777        // For now, we accept the compile-time cost of a big match.
778        match byte {
779            1 => Some(Self::Goto),
780            2 => Some(Self::Gosub),
781            3 => Some(Self::Return),
782            4 => Some(Self::InitCoroutine),
783            5 => Some(Self::EndCoroutine),
784            6 => Some(Self::Yield),
785            7 => Some(Self::HaltIfNull),
786            8 => Some(Self::Halt),
787            9 => Some(Self::Integer),
788            10 => Some(Self::Int64),
789            11 => Some(Self::Real),
790            12 => Some(Self::String8),
791            13 => Some(Self::String),
792            14 => Some(Self::BeginSubrtn),
793            15 => Some(Self::Null),
794            16 => Some(Self::SoftNull),
795            17 => Some(Self::Blob),
796            18 => Some(Self::Variable),
797            19 => Some(Self::Move),
798            20 => Some(Self::Copy),
799            21 => Some(Self::SCopy),
800            22 => Some(Self::IntCopy),
801            23 => Some(Self::FkCheck),
802            24 => Some(Self::ResultRow),
803            25 => Some(Self::Concat),
804            26 => Some(Self::Add),
805            27 => Some(Self::Subtract),
806            28 => Some(Self::Multiply),
807            29 => Some(Self::Divide),
808            30 => Some(Self::Remainder),
809            31 => Some(Self::CollSeq),
810            32 => Some(Self::BitAnd),
811            33 => Some(Self::BitOr),
812            34 => Some(Self::ShiftLeft),
813            35 => Some(Self::ShiftRight),
814            36 => Some(Self::AddImm),
815            37 => Some(Self::MustBeInt),
816            38 => Some(Self::RealAffinity),
817            39 => Some(Self::Cast),
818            40 => Some(Self::Eq),
819            41 => Some(Self::Ne),
820            42 => Some(Self::Lt),
821            43 => Some(Self::Le),
822            44 => Some(Self::Gt),
823            45 => Some(Self::Ge),
824            46 => Some(Self::ElseEq),
825            47 => Some(Self::Permutation),
826            48 => Some(Self::Compare),
827            49 => Some(Self::Jump),
828            50 => Some(Self::And),
829            51 => Some(Self::Or),
830            52 => Some(Self::IsTrue),
831            53 => Some(Self::Not),
832            54 => Some(Self::BitNot),
833            55 => Some(Self::Once),
834            56 => Some(Self::If),
835            57 => Some(Self::IfNot),
836            58 => Some(Self::IsNull),
837            59 => Some(Self::IsType),
838            60 => Some(Self::ZeroOrNull),
839            61 => Some(Self::NotNull),
840            62 => Some(Self::IfNullRow),
841            63 => Some(Self::Offset),
842            64 => Some(Self::Column),
843            65 => Some(Self::TypeCheck),
844            66 => Some(Self::Affinity),
845            67 => Some(Self::MakeRecord),
846            68 => Some(Self::Count),
847            69 => Some(Self::Savepoint),
848            70 => Some(Self::AutoCommit),
849            71 => Some(Self::Transaction),
850            72 => Some(Self::ReadCookie),
851            73 => Some(Self::SetCookie),
852            74 => Some(Self::ReopenIdx),
853            75 => Some(Self::OpenRead),
854            76 => Some(Self::OpenWrite),
855            77 => Some(Self::OpenDup),
856            78 => Some(Self::OpenEphemeral),
857            79 => Some(Self::OpenAutoindex),
858            80 => Some(Self::SorterOpen),
859            81 => Some(Self::SequenceTest),
860            82 => Some(Self::OpenPseudo),
861            83 => Some(Self::Close),
862            84 => Some(Self::ColumnsUsed),
863            85 => Some(Self::SeekLT),
864            86 => Some(Self::SeekLE),
865            87 => Some(Self::SeekGE),
866            88 => Some(Self::SeekGT),
867            89 => Some(Self::SeekScan),
868            90 => Some(Self::SeekHit),
869            91 => Some(Self::IfNotOpen),
870            92 => Some(Self::IfNoHope),
871            93 => Some(Self::NoConflict),
872            94 => Some(Self::NotFound),
873            95 => Some(Self::Found),
874            96 => Some(Self::SeekRowid),
875            97 => Some(Self::NotExists),
876            98 => Some(Self::Sequence),
877            99 => Some(Self::NewRowid),
878            100 => Some(Self::Insert),
879            101 => Some(Self::RowCell),
880            102 => Some(Self::Delete),
881            103 => Some(Self::ResetCount),
882            104 => Some(Self::SorterCompare),
883            105 => Some(Self::SorterData),
884            106 => Some(Self::RowData),
885            107 => Some(Self::Rowid),
886            108 => Some(Self::NullRow),
887            109 => Some(Self::SeekEnd),
888            110 => Some(Self::Last),
889            111 => Some(Self::IfSizeBetween),
890            112 => Some(Self::SorterSort),
891            113 => Some(Self::Sort),
892            114 => Some(Self::Rewind),
893            115 => Some(Self::IfEmpty),
894            116 => Some(Self::SorterNext),
895            117 => Some(Self::Prev),
896            118 => Some(Self::Next),
897            119 => Some(Self::IdxInsert),
898            120 => Some(Self::SorterInsert),
899            121 => Some(Self::IdxDelete),
900            122 => Some(Self::DeferredSeek),
901            123 => Some(Self::IdxRowid),
902            124 => Some(Self::FinishSeek),
903            125 => Some(Self::IdxLE),
904            126 => Some(Self::IdxGT),
905            127 => Some(Self::IdxLT),
906            128 => Some(Self::IdxGE),
907            129 => Some(Self::Destroy),
908            130 => Some(Self::Clear),
909            131 => Some(Self::ResetSorter),
910            132 => Some(Self::CreateBtree),
911            133 => Some(Self::SqlExec),
912            134 => Some(Self::ParseSchema),
913            135 => Some(Self::LoadAnalysis),
914            136 => Some(Self::DropTable),
915            137 => Some(Self::DropIndex),
916            138 => Some(Self::DropTrigger),
917            139 => Some(Self::IntegrityCk),
918            140 => Some(Self::RowSetAdd),
919            141 => Some(Self::RowSetRead),
920            142 => Some(Self::RowSetTest),
921            143 => Some(Self::Program),
922            144 => Some(Self::Param),
923            145 => Some(Self::FkCounter),
924            146 => Some(Self::FkIfZero),
925            147 => Some(Self::MemMax),
926            148 => Some(Self::IfPos),
927            149 => Some(Self::OffsetLimit),
928            150 => Some(Self::IfNotZero),
929            151 => Some(Self::DecrJumpZero),
930            152 => Some(Self::AggInverse),
931            153 => Some(Self::AggStep),
932            154 => Some(Self::AggStep1),
933            155 => Some(Self::AggValue),
934            156 => Some(Self::AggFinal),
935            157 => Some(Self::Checkpoint),
936            158 => Some(Self::JournalMode),
937            159 => Some(Self::Vacuum),
938            160 => Some(Self::IncrVacuum),
939            161 => Some(Self::Expire),
940            162 => Some(Self::CursorLock),
941            163 => Some(Self::CursorUnlock),
942            164 => Some(Self::TableLock),
943            165 => Some(Self::VBegin),
944            166 => Some(Self::VCreate),
945            167 => Some(Self::VDestroy),
946            168 => Some(Self::VOpen),
947            169 => Some(Self::VCheck),
948            170 => Some(Self::VInitIn),
949            171 => Some(Self::VFilter),
950            172 => Some(Self::VColumn),
951            173 => Some(Self::VNext),
952            174 => Some(Self::VRename),
953            175 => Some(Self::VUpdate),
954            176 => Some(Self::Pagecount),
955            177 => Some(Self::MaxPgcnt),
956            178 => Some(Self::PureFunc),
957            179 => Some(Self::Function),
958            180 => Some(Self::ClrSubtype),
959            181 => Some(Self::GetSubtype),
960            182 => Some(Self::SetSubtype),
961            183 => Some(Self::FilterAdd),
962            184 => Some(Self::Filter),
963            185 => Some(Self::Trace),
964            186 => Some(Self::Init),
965            187 => Some(Self::CursorHint),
966            188 => Some(Self::Abortable),
967            189 => Some(Self::ReleaseReg),
968            190 => Some(Self::SetSnapshot),
969            191 => Some(Self::Noop),
970            192 => Some(Self::LikeConstFast),
971            193 => Some(Self::CountIndexEqRun),
972            194 => Some(Self::FusedAppendInsert),
973            195 => Some(Self::FusedOpenWriteLast),
974            196 => Some(Self::FusedLiteralResultRow),
975            197 => Some(Self::ColumnSubstrPrefix),
976            _ => None,
977        }
978    }
979
980    /// Whether this opcode is a jump instruction (has a P2 jump target).
981    pub const fn is_jump(self) -> bool {
982        matches!(
983            self,
984            Self::Goto
985                | Self::Gosub
986                | Self::InitCoroutine
987                | Self::Yield
988                | Self::HaltIfNull
989                | Self::Once
990                | Self::If
991                | Self::IfNot
992                | Self::IsNull
993                | Self::IsType
994                | Self::NotNull
995                | Self::IfNullRow
996                | Self::Jump
997                | Self::Eq
998                | Self::Ne
999                | Self::Lt
1000                | Self::Le
1001                | Self::Gt
1002                | Self::Ge
1003                | Self::ElseEq
1004                | Self::SeekLT
1005                | Self::SeekLE
1006                | Self::SeekGE
1007                | Self::SeekGT
1008                | Self::SeekRowid
1009                | Self::NotExists
1010                | Self::IfNotOpen
1011                | Self::IfNoHope
1012                | Self::NoConflict
1013                | Self::NotFound
1014                | Self::Found
1015                | Self::Last
1016                | Self::Rewind
1017                | Self::IfEmpty
1018                | Self::IfSizeBetween
1019                | Self::Next
1020                | Self::Prev
1021                | Self::SorterNext
1022                | Self::SorterSort
1023                | Self::Sort
1024                | Self::IdxLE
1025                | Self::IdxGT
1026                | Self::IdxLT
1027                | Self::IdxGE
1028                | Self::RowSetRead
1029                | Self::RowSetTest
1030                | Self::Program
1031                | Self::FkIfZero
1032                | Self::IfPos
1033                | Self::IfNotZero
1034                | Self::DecrJumpZero
1035                | Self::IncrVacuum
1036                | Self::VFilter
1037                | Self::VNext
1038                | Self::Filter
1039                | Self::Init
1040        )
1041    }
1042}
1043
1044impl std::fmt::Display for Opcode {
1045    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1046        f.write_str(self.name())
1047    }
1048}
1049
1050/// A single VDBE instruction.
1051#[derive(Debug, Clone, PartialEq)]
1052pub struct VdbeOp {
1053    /// The opcode.
1054    pub opcode: Opcode,
1055    /// First operand (typically a register number or cursor index).
1056    pub p1: i32,
1057    /// Second operand (often a jump target address).
1058    pub p2: i32,
1059    /// Third operand.
1060    pub p3: i32,
1061    /// Fourth operand (polymorphic: string, function pointer, collation, etc.).
1062    pub p4: P4,
1063    /// Fifth operand (small flags, typically bit flags or type mask).
1064    pub p5: u16,
1065}
1066
1067/// Metadata about an index cursor for REPLACE conflict resolution.
1068///
1069/// Used by `native_replace_row` to clean up secondary index entries when
1070/// a table row is deleted due to REPLACE conflict resolution.
1071#[derive(Debug, Clone, PartialEq, Eq)]
1072pub struct IndexCursorMeta {
1073    /// Cursor ID of the index (typically table_cursor + 1, +2, ...).
1074    pub cursor_id: i32,
1075    /// Column indices (0-based positions in the table schema) that make up
1076    /// the index key. The index key is `(col[0], col[1], ..., rowid)`.
1077    pub column_indices: Vec<usize>,
1078}
1079
1080/// The P4 operand of a VDBE instruction.
1081///
1082/// P4 is a polymorphic operand that can hold different types depending on
1083/// the opcode.
1084#[derive(Debug, Clone, PartialEq)]
1085pub enum P4 {
1086    /// No P4 value.
1087    None,
1088    /// A 32-bit integer value.
1089    Int(i32),
1090    /// A 64-bit integer value.
1091    Int64(i64),
1092    /// A 64-bit float value.
1093    Real(f64),
1094    /// A string value.
1095    Str(String),
1096    /// A blob value.
1097    Blob(Vec<u8>),
1098    /// A collation sequence name.
1099    Collation(String),
1100    /// A function name (for Function/PureFunc opcodes).
1101    FuncName(String),
1102    /// A function name with an associated collation sequence for DISTINCT
1103    /// deduplication in aggregate functions (e.g. `COUNT(DISTINCT col)` where
1104    /// `col` has `COLLATE NOCASE`).
1105    FuncNameCollated(String, String),
1106    /// A table name.
1107    Table(String),
1108    /// An index name (for IdxInsert/IdxDelete opcodes).
1109    Index(String),
1110    /// An affinity string (one char per column).
1111    Affinity(String),
1112    /// A precomputed SQLite record header template for `MakeRecord`.
1113    PrecomputedHeader(crate::record::PrecomputedRecordHeader),
1114    /// Time-travel target: commit sequence for `FOR SYSTEM_TIME AS OF COMMITSEQ <n>`.
1115    TimeTravelCommitSeq(u64),
1116    /// Time-travel target: ISO-8601 timestamp for `FOR SYSTEM_TIME AS OF '<ts>'`.
1117    TimeTravelTimestamp(String),
1118}
1119
1120// ── VDBE Program Builder ────────────────────────────────────────────────────
1121//
1122// NOTE: These types intentionally live in `fsqlite-types` so that the planner
1123// (Layer 3) can generate VDBE bytecode without depending on `fsqlite-vdbe`
1124// (Layer 5). This is enforced by the workspace layering tests (bd-1wwc).
1125
1126use fsqlite_error::{FrankenError, Result};
1127use smallvec::SmallVec;
1128
1129/// An opaque handle representing a forward-reference label.
1130///
1131/// Labels allow codegen to emit jump instructions before the target address is
1132/// known. All labels MUST be resolved before execution begins; unresolved
1133/// labels are a codegen bug.
1134#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1135pub struct Label(u32);
1136
1137/// Internal tracking for label resolution.
1138#[derive(Debug)]
1139enum LabelState {
1140    /// Not yet resolved. Contains the indices of instructions whose `p2` field
1141    /// should be patched when the label is resolved.
1142    Unresolved(Vec<usize>),
1143    /// Resolved to a concrete instruction address.
1144    Resolved(i32),
1145}
1146
1147/// Sequential register allocator for the VDBE register file.
1148///
1149/// Registers are numbered starting at 1 (register 0 is reserved/unused),
1150/// matching C SQLite convention.
1151#[derive(Debug)]
1152pub struct RegisterAllocator {
1153    /// The next register number to allocate (starts at 1).
1154    next_reg: i32,
1155    /// Pool of returned temporary registers available for reuse.
1156    temp_pool: Vec<i32>,
1157}
1158
1159impl RegisterAllocator {
1160    /// Create a new allocator. First allocation returns register 1.
1161    #[must_use]
1162    pub fn new() -> Self {
1163        Self {
1164            next_reg: 1,
1165            temp_pool: Vec::new(),
1166        }
1167    }
1168
1169    /// Allocate a single persistent register.
1170    pub fn alloc_reg(&mut self) -> i32 {
1171        let reg = self.next_reg;
1172        self.next_reg += 1;
1173        reg
1174    }
1175
1176    /// Allocate a contiguous block of `n` persistent registers.
1177    ///
1178    /// Returns the first register number. The block spans `[result, result+n)`.
1179    pub fn alloc_regs(&mut self, n: i32) -> i32 {
1180        let first = self.next_reg;
1181        self.next_reg += n;
1182        first
1183    }
1184
1185    /// Allocate a temporary register (reuses from pool if available).
1186    pub fn alloc_temp(&mut self) -> i32 {
1187        self.temp_pool.pop().unwrap_or_else(|| {
1188            let reg = self.next_reg;
1189            self.next_reg += 1;
1190            reg
1191        })
1192    }
1193
1194    /// Return a temporary register to the reuse pool.
1195    pub fn free_temp(&mut self, reg: i32) {
1196        self.temp_pool.push(reg);
1197    }
1198
1199    /// The total number of registers allocated (high water mark).
1200    #[must_use]
1201    pub fn count(&self) -> i32 {
1202        self.next_reg - 1
1203    }
1204}
1205
1206impl Default for RegisterAllocator {
1207    fn default() -> Self {
1208        Self::new()
1209    }
1210}
1211
1212/// A VDBE bytecode program under construction.
1213///
1214/// Provides methods to emit instructions, create/resolve labels for forward
1215/// jumps, and allocate registers. Once construction is complete, call
1216/// [`finish`](Self::finish) to validate and extract the final instruction
1217/// sequence.
1218#[derive(Debug)]
1219pub struct ProgramBuilder {
1220    /// The instruction sequence.
1221    ops: SmallVec<[VdbeOp; 64]>,
1222    /// Label states (indexed by `Label.0`).
1223    labels: Vec<LabelState>,
1224    /// Register allocator.
1225    regs: RegisterAllocator,
1226}
1227
1228impl ProgramBuilder {
1229    /// Create a new empty program builder.
1230    #[must_use]
1231    pub fn new() -> Self {
1232        Self {
1233            ops: SmallVec::new(),
1234            labels: Vec::new(),
1235            regs: RegisterAllocator::new(),
1236        }
1237    }
1238
1239    // ── Instruction emission ────────────────────────────────────────────
1240
1241    /// Emit a single instruction and return its address (index in `ops`).
1242    pub fn emit(&mut self, op: VdbeOp) -> usize {
1243        let addr = self.ops.len();
1244        self.ops.push(op);
1245        addr
1246    }
1247
1248    /// Emit a simple instruction from parts.
1249    pub fn emit_op(&mut self, opcode: Opcode, p1: i32, p2: i32, p3: i32, p4: P4, p5: u16) -> usize {
1250        self.emit(VdbeOp {
1251            opcode,
1252            p1,
1253            p2,
1254            p3,
1255            p4,
1256            p5,
1257        })
1258    }
1259
1260    /// The current address (index of the next instruction to be emitted).
1261    #[must_use]
1262    pub fn current_addr(&self) -> usize {
1263        self.ops.len()
1264    }
1265
1266    /// Get a reference to the instruction at `addr`.
1267    #[must_use]
1268    pub fn op_at(&self, addr: usize) -> Option<&VdbeOp> {
1269        self.ops.get(addr)
1270    }
1271
1272    /// Get a mutable reference to the instruction at `addr`.
1273    #[must_use]
1274    pub fn op_at_mut(&mut self, addr: usize) -> Option<&mut VdbeOp> {
1275        self.ops.get_mut(addr)
1276    }
1277
1278    // ── Label system ────────────────────────────────────────────────────
1279
1280    /// Create a new label for forward-reference jumps.
1281    #[must_use]
1282    pub fn emit_label(&mut self) -> Label {
1283        let id = u32::try_from(self.labels.len()).expect("too many labels");
1284        self.labels.push(LabelState::Unresolved(Vec::new()));
1285        Label(id)
1286    }
1287
1288    /// Emit a jump instruction whose p2 target is a label (forward reference).
1289    ///
1290    /// The label's address will be patched into p2 when `resolve_label` is called.
1291    pub fn emit_jump_to_label(
1292        &mut self,
1293        opcode: Opcode,
1294        p1: i32,
1295        p3: i32,
1296        label: Label,
1297        p4: P4,
1298        p5: u16,
1299    ) -> usize {
1300        let addr = self.emit(VdbeOp {
1301            opcode,
1302            p1,
1303            p2: -1, // placeholder; will be patched
1304            p3,
1305            p4,
1306            p5,
1307        });
1308
1309        let state = self
1310            .labels
1311            .get_mut(usize::try_from(label.0).expect("label fits usize"))
1312            .expect("label must exist");
1313
1314        match state {
1315            LabelState::Unresolved(refs) => refs.push(addr),
1316            LabelState::Resolved(target) => {
1317                // Label already resolved; patch immediately.
1318                self.ops[addr].p2 = *target;
1319            }
1320        }
1321
1322        addr
1323    }
1324
1325    /// Resolve a label to the current address and patch all forward refs.
1326    pub fn resolve_label(&mut self, label: Label) {
1327        let addr = i32::try_from(self.current_addr()).expect("program too large");
1328        self.resolve_label_to(label, addr);
1329    }
1330
1331    /// Resolve a label to an explicit address (used for some control patterns).
1332    pub fn resolve_label_to(&mut self, label: Label, address: i32) {
1333        let idx = usize::try_from(label.0).expect("label fits usize");
1334        let state = self.labels.get_mut(idx).expect("label must exist");
1335
1336        match state {
1337            LabelState::Unresolved(refs) => {
1338                // Patch all references.
1339                for &ref_addr in refs.iter() {
1340                    self.ops[ref_addr].p2 = address;
1341                }
1342                *state = LabelState::Resolved(address);
1343            }
1344            LabelState::Resolved(_) => {
1345                // Idempotent: resolving twice is allowed as long as it's consistent.
1346                *state = LabelState::Resolved(address);
1347            }
1348        }
1349    }
1350
1351    // ── Register allocation ─────────────────────────────────────────────
1352
1353    /// Allocate a single persistent register.
1354    pub fn alloc_reg(&mut self) -> i32 {
1355        self.regs.alloc_reg()
1356    }
1357
1358    /// Allocate a contiguous block of persistent registers.
1359    pub fn alloc_regs(&mut self, n: i32) -> i32 {
1360        self.regs.alloc_regs(n)
1361    }
1362
1363    /// Allocate a temporary register (reusable).
1364    pub fn alloc_temp(&mut self) -> i32 {
1365        self.regs.alloc_temp()
1366    }
1367
1368    /// Return a temporary register to the pool.
1369    pub fn free_temp(&mut self, reg: i32) {
1370        self.regs.free_temp(reg);
1371    }
1372
1373    /// Total registers allocated (high water mark).
1374    #[must_use]
1375    pub fn register_count(&self) -> i32 {
1376        self.regs.count()
1377    }
1378
1379    // ── Peephole Passes (IMPL-13) ───────────────────────────────────────
1380
1381    /// Fuse `Integer(lit, reg) + ResultRow(reg, 1)` pairs into
1382    /// `FusedLiteralResultRow(lit, reg)` + `Noop`.
1383    ///
1384    /// Rewrites in-place so program counters, jump targets, and the label
1385    /// tables remain valid without rewiring. The `ResultRow` is replaced by a
1386    /// `Noop` rather than removed so no following instruction shifts.
1387    ///
1388    /// Conservative preconditions per fusion site:
1389    /// - The `Integer`'s target register equals the `ResultRow`'s start
1390    ///   register.
1391    /// - The `ResultRow` emits exactly one column (`p2 == 1`).
1392    /// - The `ResultRow` is NOT a resolved jump target from any prior jump
1393    ///   in this program (a mid-pair jump would otherwise skip the Integer
1394    ///   write and run `ResultRow` against an unrelated register value).
1395    /// - Neither instruction carries a non-`None` P4 payload (Integer/ResultRow
1396    ///   don't use P4 in their canonical form).
1397    /// - Both instructions carry P5 == 0 and P3 == 0.
1398    ///
1399    /// Returns the number of fusions performed.
1400    pub fn apply_fuse_literal_result_row(&mut self) -> usize {
1401        // Collect the set of resolved jump targets. Any address that is the
1402        // target of some jump instruction's `p2` is ineligible to be the
1403        // second half of a fusion pair.
1404        let mut jump_targets: std::collections::HashSet<i32> = std::collections::HashSet::new();
1405        for op in &self.ops {
1406            if op.opcode.is_jump() {
1407                jump_targets.insert(op.p2);
1408            }
1409        }
1410
1411        let mut fused = 0usize;
1412        let len = self.ops.len();
1413        let mut i = 0;
1414        while i + 1 < len {
1415            let is_int = matches!(self.ops[i].opcode, Opcode::Integer)
1416                && self.ops[i].p3 == 0
1417                && self.ops[i].p5 == 0
1418                && matches!(self.ops[i].p4, P4::None);
1419            let is_row = matches!(self.ops[i + 1].opcode, Opcode::ResultRow)
1420                && self.ops[i + 1].p2 == 1
1421                && self.ops[i + 1].p3 == 0
1422                && self.ops[i + 1].p5 == 0
1423                && matches!(self.ops[i + 1].p4, P4::None);
1424            let same_reg = is_int && is_row && self.ops[i].p2 == self.ops[i + 1].p1;
1425            let row_addr = i32::try_from(i + 1).ok();
1426            let row_is_target = row_addr.is_some_and(|a| jump_targets.contains(&a));
1427
1428            if same_reg && !row_is_target {
1429                let lit = self.ops[i].p1;
1430                let reg = self.ops[i].p2;
1431                self.ops[i] = VdbeOp {
1432                    opcode: Opcode::FusedLiteralResultRow,
1433                    p1: lit,
1434                    p2: reg,
1435                    p3: 0,
1436                    p4: P4::None,
1437                    p5: 0,
1438                };
1439                self.ops[i + 1] = VdbeOp {
1440                    opcode: Opcode::Noop,
1441                    p1: 0,
1442                    p2: 0,
1443                    p3: 0,
1444                    p4: P4::None,
1445                    p5: 0,
1446                };
1447                fused += 1;
1448                i += 2;
1449            } else {
1450                i += 1;
1451            }
1452        }
1453        fused
1454    }
1455
1456    // ── Finalization ────────────────────────────────────────────────────
1457
1458    /// Validate all labels are resolved and return the finished program.
1459    pub fn finish(self) -> Result<VdbeProgram> {
1460        // Check for unresolved labels.
1461        for (i, state) in self.labels.iter().enumerate() {
1462            if let LabelState::Unresolved(refs) = state {
1463                if !refs.is_empty() {
1464                    return Err(FrankenError::Internal(format!(
1465                        "unresolved label {i} referenced by {} instruction(s)",
1466                        refs.len()
1467                    )));
1468                }
1469            }
1470        }
1471
1472        Ok(VdbeProgram {
1473            ops: self.ops,
1474            register_count: self.regs.count(),
1475        })
1476    }
1477}
1478
1479impl Default for ProgramBuilder {
1480    fn default() -> Self {
1481        Self::new()
1482    }
1483}
1484
1485/// A finalized VDBE bytecode program ready for execution.
1486#[derive(Debug, Clone, PartialEq)]
1487pub struct VdbeProgram {
1488    /// The instruction sequence.
1489    ops: SmallVec<[VdbeOp; 64]>,
1490    /// Number of registers needed (high water mark from allocation).
1491    register_count: i32,
1492}
1493
1494impl VdbeProgram {
1495    /// The instruction sequence.
1496    #[must_use]
1497    pub fn ops(&self) -> &[VdbeOp] {
1498        &self.ops
1499    }
1500
1501    /// Number of instructions.
1502    #[must_use]
1503    pub fn len(&self) -> usize {
1504        self.ops.len()
1505    }
1506
1507    /// Whether the program is empty.
1508    #[must_use]
1509    pub fn is_empty(&self) -> bool {
1510        self.ops.is_empty()
1511    }
1512
1513    /// Number of registers required.
1514    #[must_use]
1515    pub fn register_count(&self) -> i32 {
1516        self.register_count
1517    }
1518
1519    /// Get the instruction at the given program counter.
1520    #[must_use]
1521    pub fn get(&self, pc: usize) -> Option<&VdbeOp> {
1522        self.ops.get(pc)
1523    }
1524
1525    /// Disassemble the program to a human-readable string.
1526    ///
1527    /// Output format matches SQLite's `EXPLAIN` output.
1528    #[must_use]
1529    pub fn disassemble(&self) -> String {
1530        use std::fmt::Write;
1531
1532        let mut out = std::string::String::with_capacity(self.ops.len() * 60);
1533        out.push_str("addr  opcode           p1    p2    p3    p4                 p5\n");
1534        out.push_str("----  ---------------  ----  ----  ----  -----------------  --\n");
1535
1536        for (addr, op) in self.ops.iter().enumerate() {
1537            let p4_str = match &op.p4 {
1538                P4::None => String::new(),
1539                P4::Int(v) => format!("(int){v}"),
1540                P4::Int64(v) => format!("(i64){v}"),
1541                P4::Real(v) => format!("(real){v}"),
1542                P4::Str(s) => format!("(str){s}"),
1543                P4::Blob(b) => format!("(blob)[{}B]", b.len()),
1544                P4::Collation(c) => format!("(coll){c}"),
1545                P4::FuncName(f) => format!("(func){f}"),
1546                P4::FuncNameCollated(f, c) => format!("(func){f} coll={c}"),
1547                P4::Table(t) => format!("(tbl){t}"),
1548                P4::Index(i) => format!("(idx){i}"),
1549                P4::Affinity(a) => format!("(aff){a}"),
1550                P4::PrecomputedHeader(header) => format!("(hdr)[{}B]", header.template.len()),
1551                P4::TimeTravelCommitSeq(seq) => format!("(tt-seq){seq}"),
1552                P4::TimeTravelTimestamp(ts) => format!("(tt-ts){ts}"),
1553            };
1554
1555            writeln!(
1556                &mut out,
1557                "{addr:<4}  {:<15}  {:<4}  {:<4}  {:<4}  {:<17}  {:<2}",
1558                op.opcode.name(),
1559                op.p1,
1560                op.p2,
1561                op.p3,
1562                p4_str,
1563                op.p5,
1564            )
1565            .expect("write to string");
1566        }
1567
1568        out
1569    }
1570}
1571
1572#[cfg(test)]
1573#[allow(clippy::approx_constant)]
1574mod tests {
1575    use super::*;
1576    use std::collections::HashSet;
1577
1578    #[test]
1579    fn opcode_count() {
1580        assert_eq!(Opcode::COUNT, 198);
1581    }
1582
1583    #[test]
1584    fn opcode_name_roundtrip() {
1585        // Spot check a few opcodes
1586        assert_eq!(Opcode::Goto.name(), "Goto");
1587        assert_eq!(Opcode::Halt.name(), "Halt");
1588        assert_eq!(Opcode::Insert.name(), "Insert");
1589        assert_eq!(Opcode::Delete.name(), "Delete");
1590        assert_eq!(Opcode::ResultRow.name(), "ResultRow");
1591        assert_eq!(Opcode::Noop.name(), "Noop");
1592    }
1593
1594    #[test]
1595    fn opcode_from_byte() {
1596        assert_eq!(Opcode::from_byte(0), None);
1597        assert_eq!(Opcode::from_byte(1), Some(Opcode::Goto));
1598        assert_eq!(Opcode::from_byte(8), Some(Opcode::Halt));
1599        assert_eq!(Opcode::from_byte(190), Some(Opcode::SetSnapshot));
1600        assert_eq!(Opcode::from_byte(191), Some(Opcode::Noop));
1601        assert_eq!(Opcode::from_byte(192), Some(Opcode::LikeConstFast));
1602        assert_eq!(Opcode::from_byte(196), Some(Opcode::FusedLiteralResultRow));
1603        assert_eq!(Opcode::from_byte(197), Some(Opcode::ColumnSubstrPrefix));
1604        assert_eq!(Opcode::from_byte(198), None);
1605        assert_eq!(Opcode::from_byte(255), None);
1606    }
1607
1608    #[test]
1609    fn opcode_from_byte_exhaustive() {
1610        // Every assigned opcode byte should produce Some.
1611        for i in 1..Opcode::COUNT as u8 {
1612            assert!(
1613                Opcode::from_byte(i).is_some(),
1614                "from_byte({i}) returned None"
1615            );
1616        }
1617    }
1618
1619    #[test]
1620    fn test_opcode_distinct_u8_values() {
1621        let mut encoded = HashSet::new();
1622        for byte in 1..Opcode::COUNT as u8 {
1623            let opcode = Opcode::from_byte(byte).expect("opcode byte must decode");
1624            let inserted = encoded.insert(opcode as u8);
1625            assert!(inserted, "duplicate opcode byte value for {:?}", opcode);
1626        }
1627
1628        assert_eq!(
1629            encoded.len(),
1630            Opcode::COUNT - 1,
1631            "every opcode must map to a unique byte"
1632        );
1633    }
1634
1635    #[test]
1636    fn opcode_display() {
1637        assert_eq!(Opcode::Goto.to_string(), "Goto");
1638        assert_eq!(Opcode::Init.to_string(), "Init");
1639    }
1640
1641    #[test]
1642    fn opcode_is_jump() {
1643        assert!(Opcode::Goto.is_jump());
1644        assert!(Opcode::If.is_jump());
1645        assert!(Opcode::IfNot.is_jump());
1646        assert!(Opcode::Eq.is_jump());
1647        assert!(Opcode::Next.is_jump());
1648        assert!(Opcode::Rewind.is_jump());
1649        assert!(Opcode::Init.is_jump());
1650
1651        assert!(!Opcode::Integer.is_jump());
1652        assert!(!Opcode::Add.is_jump());
1653        assert!(!Opcode::Insert.is_jump());
1654        assert!(!Opcode::Noop.is_jump());
1655        assert!(!Opcode::ResultRow.is_jump());
1656    }
1657
1658    #[test]
1659    fn vdbe_op_basic() {
1660        let op = VdbeOp {
1661            opcode: Opcode::Integer,
1662            p1: 42,
1663            p2: 1,
1664            p3: 0,
1665            p4: P4::None,
1666            p5: 0,
1667        };
1668        assert_eq!(op.opcode, Opcode::Integer);
1669        assert_eq!(op.p1, 42);
1670    }
1671
1672    #[test]
1673    fn p4_variants() {
1674        let p4 = P4::Int(42);
1675        assert_eq!(p4, P4::Int(42));
1676
1677        let p4 = P4::Str("hello".to_owned());
1678        assert_eq!(p4, P4::Str("hello".to_owned()));
1679
1680        let p4 = P4::Real(3.14);
1681        assert_eq!(p4, P4::Real(3.14));
1682    }
1683}