/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact c044be7050ac6bf596eecc6ab159f5dbc020a3b7:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 35 0a 2a 2a 0a 2a 2a 20 54 68  mber 15.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you give..**.***
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 2a 2a 0a 2a 2a 20 48 65 61 64 65 72  ******.** Header
0180: 20 66 69 6c 65 20 66 6f 72 20 74 68 65 20 56 69   file for the Vi
0190: 72 74 75 61 6c 20 44 61 74 61 42 61 73 65 20 45  rtual DataBase E
01a0: 6e 67 69 6e 65 20 28 56 44 42 45 29 0a 2a 2a 0a  ngine (VDBE).**.
01b0: 2a 2a 20 54 68 69 73 20 68 65 61 64 65 72 20 64  ** This header d
01c0: 65 66 69 6e 65 73 20 74 68 65 20 69 6e 74 65 72  efines the inter
01d0: 66 61 63 65 20 74 6f 20 74 68 65 20 76 69 72 74  face to the virt
01e0: 75 61 6c 20 64 61 74 61 62 61 73 65 20 65 6e 67  ual database eng
01f0: 69 6e 65 0a 2a 2a 20 6f 72 20 56 44 42 45 2e 20  ine.** or VDBE. 
0200: 20 54 68 65 20 56 44 42 45 20 69 6d 70 6c 65 6d   The VDBE implem
0210: 65 6e 74 73 20 61 6e 20 61 62 73 74 72 61 63 74  ents an abstract
0220: 20 6d 61 63 68 69 6e 65 20 74 68 61 74 20 72 75   machine that ru
0230: 6e 73 20 61 0a 2a 2a 20 73 69 6d 70 6c 65 20 70  ns a.** simple p
0240: 72 6f 67 72 61 6d 20 74 6f 20 61 63 63 65 73 73  rogram to access
0250: 20 61 6e 64 20 6d 6f 64 69 66 79 20 74 68 65 20   and modify the 
0260: 75 6e 64 65 72 6c 79 69 6e 67 20 64 61 74 61 62  underlying datab
0270: 61 73 65 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66 20  ase..*/.#ifndef 
0280: 53 51 4c 49 54 45 5f 56 44 42 45 5f 48 0a 23 64  SQLITE_VDBE_H.#d
0290: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 56 44 42  efine SQLITE_VDB
02a0: 45 5f 48 0a 23 69 6e 63 6c 75 64 65 20 3c 73 74  E_H.#include <st
02b0: 64 69 6f 2e 68 3e 0a 0a 2f 2a 0a 2a 2a 20 41 20  dio.h>../*.** A 
02c0: 73 69 6e 67 6c 65 20 56 44 42 45 20 69 73 20 61  single VDBE is a
02d0: 6e 20 6f 70 61 71 75 65 20 73 74 72 75 63 74 75  n opaque structu
02e0: 72 65 20 6e 61 6d 65 64 20 22 56 64 62 65 22 2e  re named "Vdbe".
02f0: 20 20 4f 6e 6c 79 20 72 6f 75 74 69 6e 65 73 0a    Only routines.
0300: 2a 2a 20 69 6e 20 74 68 65 20 73 6f 75 72 63 65  ** in the source
0310: 20 66 69 6c 65 20 73 71 6c 69 74 65 56 64 62 65   file sqliteVdbe
0320: 2e 63 20 61 72 65 20 61 6c 6c 6f 77 65 64 20 74  .c are allowed t
0330: 6f 20 73 65 65 20 74 68 65 20 69 6e 73 69 64 65  o see the inside
0340: 73 0a 2a 2a 20 6f 66 20 74 68 69 73 20 73 74 72  s.** of this str
0350: 75 63 74 75 72 65 2e 0a 2a 2f 0a 74 79 70 65 64  ucture..*/.typed
0360: 65 66 20 73 74 72 75 63 74 20 56 64 62 65 20 56  ef struct Vdbe V
0370: 64 62 65 3b 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20  dbe;../*.** The 
0380: 6e 61 6d 65 73 20 6f 66 20 74 68 65 20 66 6f 6c  names of the fol
0390: 6c 6f 77 69 6e 67 20 74 79 70 65 73 20 64 65 63  lowing types dec
03a0: 6c 61 72 65 64 20 69 6e 20 76 64 62 65 49 6e 74  lared in vdbeInt
03b0: 2e 68 20 61 72 65 20 72 65 71 75 69 72 65 64 0a  .h are required.
03c0: 2a 2a 20 66 6f 72 20 74 68 65 20 56 64 62 65 4f  ** for the VdbeO
03d0: 70 20 64 65 66 69 6e 69 74 69 6f 6e 2e 0a 2a 2f  p definition..*/
03e0: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
03f0: 4d 65 6d 20 4d 65 6d 3b 0a 74 79 70 65 64 65 66  Mem Mem;.typedef
0400: 20 73 74 72 75 63 74 20 53 75 62 50 72 6f 67 72   struct SubProgr
0410: 61 6d 20 53 75 62 50 72 6f 67 72 61 6d 3b 0a 0a  am SubProgram;..
0420: 2f 2a 0a 2a 2a 20 41 20 73 69 6e 67 6c 65 20 69  /*.** A single i
0430: 6e 73 74 72 75 63 74 69 6f 6e 20 6f 66 20 74 68  nstruction of th
0440: 65 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e  e virtual machin
0450: 65 20 68 61 73 20 61 6e 20 6f 70 63 6f 64 65 0a  e has an opcode.
0460: 2a 2a 20 61 6e 64 20 61 73 20 6d 61 6e 79 20 61  ** and as many a
0470: 73 20 74 68 72 65 65 20 6f 70 65 72 61 6e 64 73  s three operands
0480: 2e 20 20 54 68 65 20 69 6e 73 74 72 75 63 74 69  .  The instructi
0490: 6f 6e 20 69 73 20 72 65 63 6f 72 64 65 64 0a 2a  on is recorded.*
04a0: 2a 20 61 73 20 61 6e 20 69 6e 73 74 61 6e 63 65  * as an instance
04b0: 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e   of the followin
04c0: 67 20 73 74 72 75 63 74 75 72 65 3a 0a 2a 2f 0a  g structure:.*/.
04d0: 73 74 72 75 63 74 20 56 64 62 65 4f 70 20 7b 0a  struct VdbeOp {.
04e0: 20 20 75 38 20 6f 70 63 6f 64 65 3b 20 20 20 20    u8 opcode;    
04f0: 20 20 20 20 20 20 2f 2a 20 57 68 61 74 20 6f 70        /* What op
0500: 65 72 61 74 69 6f 6e 20 74 6f 20 70 65 72 66 6f  eration to perfo
0510: 72 6d 20 2a 2f 0a 20 20 73 69 67 6e 65 64 20 63  rm */.  signed c
0520: 68 61 72 20 70 34 74 79 70 65 3b 20 2f 2a 20 4f  har p4type; /* O
0530: 6e 65 20 6f 66 20 74 68 65 20 50 34 5f 78 78 78  ne of the P4_xxx
0540: 20 63 6f 6e 73 74 61 6e 74 73 20 66 6f 72 20 70   constants for p
0550: 34 20 2a 2f 0a 20 20 75 38 20 6e 6f 74 55 73 65  4 */.  u8 notUse
0560: 64 31 3b 0a 20 20 75 38 20 70 35 3b 20 20 20 20  d1;.  u8 p5;    
0570: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 69 66            /* Fif
0580: 74 68 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  th parameter is 
0590: 61 6e 20 75 6e 73 69 67 6e 65 64 20 63 68 61 72  an unsigned char
05a0: 61 63 74 65 72 20 2a 2f 0a 20 20 69 6e 74 20 70  acter */.  int p
05b0: 31 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 2f  1;             /
05c0: 2a 20 46 69 72 73 74 20 6f 70 65 72 61 6e 64 20  * First operand 
05d0: 2a 2f 0a 20 20 69 6e 74 20 70 32 3b 20 20 20 20  */.  int p2;    
05e0: 20 20 20 20 20 20 20 20 20 2f 2a 20 53 65 63 6f           /* Seco
05f0: 6e 64 20 70 61 72 61 6d 65 74 65 72 20 28 6f 66  nd parameter (of
0600: 74 65 6e 20 74 68 65 20 6a 75 6d 70 20 64 65 73  ten the jump des
0610: 74 69 6e 61 74 69 6f 6e 29 20 2a 2f 0a 20 20 69  tination) */.  i
0620: 6e 74 20 70 33 3b 20 20 20 20 20 20 20 20 20 20  nt p3;          
0630: 20 20 20 2f 2a 20 54 68 65 20 74 68 69 72 64 20     /* The third 
0640: 70 61 72 61 6d 65 74 65 72 20 2a 2f 0a 20 20 75  parameter */.  u
0650: 6e 69 6f 6e 20 70 34 75 6e 69 6f 6e 20 7b 20 20  nion p4union {  
0660: 20 20 20 2f 2a 20 66 6f 75 72 74 68 20 70 61 72     /* fourth par
0670: 61 6d 65 74 65 72 20 2a 2f 0a 20 20 20 20 69 6e  ameter */.    in
0680: 74 20 69 3b 20 20 20 20 20 20 20 20 20 20 20 20  t i;            
0690: 20 20 20 20 20 2f 2a 20 49 6e 74 65 67 65 72 20       /* Integer 
06a0: 76 61 6c 75 65 20 69 66 20 70 34 74 79 70 65 3d  value if p4type=
06b0: 3d 50 34 5f 49 4e 54 33 32 20 2a 2f 0a 20 20 20  =P4_INT32 */.   
06c0: 20 76 6f 69 64 20 2a 70 3b 20 20 20 20 20 20 20   void *p;       
06d0: 20 20 20 20 20 20 20 20 2f 2a 20 47 65 6e 65 72          /* Gener
06e0: 69 63 20 70 6f 69 6e 74 65 72 20 2a 2f 0a 20 20  ic pointer */.  
06f0: 20 20 63 68 61 72 20 2a 7a 3b 20 20 20 20 20 20    char *z;      
0700: 20 20 20 20 20 20 20 20 20 2f 2a 20 50 6f 69 6e           /* Poin
0710: 74 65 72 20 74 6f 20 64 61 74 61 20 66 6f 72 20  ter to data for 
0720: 73 74 72 69 6e 67 20 28 63 68 61 72 20 61 72 72  string (char arr
0730: 61 79 29 20 74 79 70 65 73 20 2a 2f 0a 20 20 20  ay) types */.   
0740: 20 69 36 34 20 2a 70 49 36 34 3b 20 20 20 20 20   i64 *pI64;     
0750: 20 20 20 20 20 20 20 20 2f 2a 20 55 73 65 64 20          /* Used 
0760: 77 68 65 6e 20 70 34 74 79 70 65 20 69 73 20 50  when p4type is P
0770: 34 5f 49 4e 54 36 34 20 2a 2f 0a 20 20 20 20 64  4_INT64 */.    d
0780: 6f 75 62 6c 65 20 2a 70 52 65 61 6c 3b 20 20 20  ouble *pReal;   
0790: 20 20 20 20 20 20 2f 2a 20 55 73 65 64 20 77 68        /* Used wh
07a0: 65 6e 20 70 34 74 79 70 65 20 69 73 20 50 34 5f  en p4type is P4_
07b0: 52 45 41 4c 20 2a 2f 0a 20 20 20 20 46 75 6e 63  REAL */.    Func
07c0: 44 65 66 20 2a 70 46 75 6e 63 3b 20 20 20 20 20  Def *pFunc;     
07d0: 20 20 20 2f 2a 20 55 73 65 64 20 77 68 65 6e 20     /* Used when 
07e0: 70 34 74 79 70 65 20 69 73 20 50 34 5f 46 55 4e  p4type is P4_FUN
07f0: 43 44 45 46 20 2a 2f 0a 20 20 20 20 73 71 6c 69  CDEF */.    sqli
0800: 74 65 33 5f 63 6f 6e 74 65 78 74 20 2a 70 43 74  te3_context *pCt
0810: 78 3b 20 2f 2a 20 55 73 65 64 20 77 68 65 6e 20  x; /* Used when 
0820: 70 34 74 79 70 65 20 69 73 20 50 34 5f 46 55 4e  p4type is P4_FUN
0830: 43 43 54 58 20 2a 2f 0a 20 20 20 20 43 6f 6c 6c  CCTX */.    Coll
0840: 53 65 71 20 2a 70 43 6f 6c 6c 3b 20 20 20 20 20  Seq *pColl;     
0850: 20 20 20 2f 2a 20 55 73 65 64 20 77 68 65 6e 20     /* Used when 
0860: 70 34 74 79 70 65 20 69 73 20 50 34 5f 43 4f 4c  p4type is P4_COL
0870: 4c 53 45 51 20 2a 2f 0a 20 20 20 20 4d 65 6d 20  LSEQ */.    Mem 
0880: 2a 70 4d 65 6d 3b 20 20 20 20 20 20 20 20 20 20  *pMem;          
0890: 20 20 20 2f 2a 20 55 73 65 64 20 77 68 65 6e 20     /* Used when 
08a0: 70 34 74 79 70 65 20 69 73 20 50 34 5f 4d 45 4d  p4type is P4_MEM
08b0: 20 2a 2f 0a 20 20 20 20 56 54 61 62 6c 65 20 2a   */.    VTable *
08c0: 70 56 74 61 62 3b 20 20 20 20 20 20 20 20 20 2f  pVtab;         /
08d0: 2a 20 55 73 65 64 20 77 68 65 6e 20 70 34 74 79  * Used when p4ty
08e0: 70 65 20 69 73 20 50 34 5f 56 54 41 42 20 2a 2f  pe is P4_VTAB */
08f0: 0a 20 20 20 20 4b 65 79 49 6e 66 6f 20 2a 70 4b  .    KeyInfo *pK
0900: 65 79 49 6e 66 6f 3b 20 20 20 20 20 2f 2a 20 55  eyInfo;     /* U
0910: 73 65 64 20 77 68 65 6e 20 70 34 74 79 70 65 20  sed when p4type 
0920: 69 73 20 50 34 5f 4b 45 59 49 4e 46 4f 20 2a 2f  is P4_KEYINFO */
0930: 0a 20 20 20 20 69 6e 74 20 2a 61 69 3b 20 20 20  .    int *ai;   
0940: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 55              /* U
0950: 73 65 64 20 77 68 65 6e 20 70 34 74 79 70 65 20  sed when p4type 
0960: 69 73 20 50 34 5f 49 4e 54 41 52 52 41 59 20 2a  is P4_INTARRAY *
0970: 2f 0a 20 20 20 20 53 75 62 50 72 6f 67 72 61 6d  /.    SubProgram
0980: 20 2a 70 50 72 6f 67 72 61 6d 3b 20 20 2f 2a 20   *pProgram;  /* 
0990: 55 73 65 64 20 77 68 65 6e 20 70 34 74 79 70 65  Used when p4type
09a0: 20 69 73 20 50 34 5f 53 55 42 50 52 4f 47 52 41   is P4_SUBPROGRA
09b0: 4d 20 2a 2f 0a 20 20 20 20 54 61 62 6c 65 20 2a  M */.    Table *
09c0: 70 54 61 62 3b 20 20 20 20 20 20 20 20 20 20 20  pTab;           
09d0: 2f 2a 20 55 73 65 64 20 77 68 65 6e 20 70 34 74  /* Used when p4t
09e0: 79 70 65 20 69 73 20 50 34 5f 54 41 42 4c 45 20  ype is P4_TABLE 
09f0: 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45  */.#ifdef SQLITE
0a00: 5f 45 4e 41 42 4c 45 5f 43 55 52 53 4f 52 5f 48  _ENABLE_CURSOR_H
0a10: 49 4e 54 53 0a 20 20 20 20 45 78 70 72 20 2a 70  INTS.    Expr *p
0a20: 45 78 70 72 3b 20 20 20 20 20 20 20 20 20 20 20  Expr;           
0a30: 2f 2a 20 55 73 65 64 20 77 68 65 6e 20 70 34 74  /* Used when p4t
0a40: 79 70 65 20 69 73 20 50 34 5f 45 58 50 52 20 2a  ype is P4_EXPR *
0a50: 2f 0a 23 65 6e 64 69 66 0a 20 20 20 20 69 6e 74  /.#endif.    int
0a60: 20 28 2a 78 41 64 76 61 6e 63 65 29 28 42 74 43   (*xAdvance)(BtC
0a70: 75 72 73 6f 72 20 2a 2c 20 69 6e 74 20 2a 29 3b  ursor *, int *);
0a80: 0a 20 20 7d 20 70 34 3b 0a 23 69 66 64 65 66 20  .  } p4;.#ifdef 
0a90: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 45 58  SQLITE_ENABLE_EX
0aa0: 50 4c 41 49 4e 5f 43 4f 4d 4d 45 4e 54 53 0a 20  PLAIN_COMMENTS. 
0ab0: 20 63 68 61 72 20 2a 7a 43 6f 6d 6d 65 6e 74 3b   char *zComment;
0ac0: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 43 6f 6d            /* Com
0ad0: 6d 65 6e 74 20 74 6f 20 69 6d 70 72 6f 76 65 20  ment to improve 
0ae0: 72 65 61 64 61 62 69 6c 69 74 79 20 2a 2f 0a 23  readability */.#
0af0: 65 6e 64 69 66 0a 23 69 66 64 65 66 20 56 44 42  endif.#ifdef VDB
0b00: 45 5f 50 52 4f 46 49 4c 45 0a 20 20 75 33 32 20  E_PROFILE.  u32 
0b10: 63 6e 74 3b 20 20 20 20 20 20 20 20 20 20 20 20  cnt;            
0b20: 20 20 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f       /* Number o
0b30: 66 20 74 69 6d 65 73 20 74 68 69 73 20 69 6e 73  f times this ins
0b40: 74 72 75 63 74 69 6f 6e 20 77 61 73 20 65 78 65  truction was exe
0b50: 63 75 74 65 64 20 2a 2f 0a 20 20 75 36 34 20 63  cuted */.  u64 c
0b60: 79 63 6c 65 73 3b 20 20 20 20 20 20 20 20 20 20  ycles;          
0b70: 20 20 20 20 2f 2a 20 54 6f 74 61 6c 20 74 69 6d      /* Total tim
0b80: 65 20 73 70 65 6e 74 20 65 78 65 63 75 74 69 6e  e spent executin
0b90: 67 20 74 68 69 73 20 69 6e 73 74 72 75 63 74 69  g this instructi
0ba0: 6f 6e 20 2a 2f 0a 23 65 6e 64 69 66 0a 23 69 66  on */.#endif.#if
0bb0: 64 65 66 20 53 51 4c 49 54 45 5f 56 44 42 45 5f  def SQLITE_VDBE_
0bc0: 43 4f 56 45 52 41 47 45 0a 20 20 69 6e 74 20 69  COVERAGE.  int i
0bd0: 53 72 63 4c 69 6e 65 3b 20 20 20 20 20 20 20 20  SrcLine;        
0be0: 20 20 20 20 2f 2a 20 53 6f 75 72 63 65 2d 63 6f      /* Source-co
0bf0: 64 65 20 6c 69 6e 65 20 74 68 61 74 20 67 65 6e  de line that gen
0c00: 65 72 61 74 65 64 20 74 68 69 73 20 6f 70 63 6f  erated this opco
0c10: 64 65 20 2a 2f 0a 23 65 6e 64 69 66 0a 7d 3b 0a  de */.#endif.};.
0c20: 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 56  typedef struct V
0c30: 64 62 65 4f 70 20 56 64 62 65 4f 70 3b 0a 0a 0a  dbeOp VdbeOp;...
0c40: 2f 2a 0a 2a 2a 20 41 20 73 75 62 2d 72 6f 75 74  /*.** A sub-rout
0c50: 69 6e 65 20 75 73 65 64 20 74 6f 20 69 6d 70 6c  ine used to impl
0c60: 65 6d 65 6e 74 20 61 20 74 72 69 67 67 65 72 20  ement a trigger 
0c70: 70 72 6f 67 72 61 6d 2e 0a 2a 2f 0a 73 74 72 75  program..*/.stru
0c80: 63 74 20 53 75 62 50 72 6f 67 72 61 6d 20 7b 0a  ct SubProgram {.
0c90: 20 20 56 64 62 65 4f 70 20 2a 61 4f 70 3b 20 20    VdbeOp *aOp;  
0ca0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0cb0: 2f 2a 20 41 72 72 61 79 20 6f 66 20 6f 70 63 6f  /* Array of opco
0cc0: 64 65 73 20 66 6f 72 20 73 75 62 2d 70 72 6f 67  des for sub-prog
0cd0: 72 61 6d 20 2a 2f 0a 20 20 69 6e 74 20 6e 4f 70  ram */.  int nOp
0ce0: 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ;               
0cf0: 20 20 20 20 20 20 20 2f 2a 20 45 6c 65 6d 65 6e         /* Elemen
0d00: 74 73 20 69 6e 20 61 4f 70 5b 5d 20 2a 2f 0a 20  ts in aOp[] */. 
0d10: 20 69 6e 74 20 6e 4d 65 6d 3b 20 20 20 20 20 20   int nMem;      
0d20: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0d30: 2a 20 4e 75 6d 62 65 72 20 6f 66 20 6d 65 6d 6f  * Number of memo
0d40: 72 79 20 63 65 6c 6c 73 20 72 65 71 75 69 72 65  ry cells require
0d50: 64 20 2a 2f 0a 20 20 69 6e 74 20 6e 43 73 72 3b  d */.  int nCsr;
0d60: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0d70: 20 20 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f       /* Number o
0d80: 66 20 63 75 72 73 6f 72 73 20 72 65 71 75 69 72  f cursors requir
0d90: 65 64 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 74 6f  ed */.  void *to
0da0: 6b 65 6e 3b 20 20 20 20 20 20 20 20 20 20 20 20  ken;            
0db0: 20 20 20 20 20 20 2f 2a 20 69 64 20 74 68 61 74        /* id that
0dc0: 20 6d 61 79 20 62 65 20 75 73 65 64 20 74 6f 20   may be used to 
0dd0: 72 65 63 75 72 73 69 76 65 20 74 72 69 67 67 65  recursive trigge
0de0: 72 73 20 2a 2f 0a 20 20 53 75 62 50 72 6f 67 72  rs */.  SubProgr
0df0: 61 6d 20 2a 70 4e 65 78 74 3b 20 20 20 20 20 20  am *pNext;      
0e00: 20 20 20 20 20 20 2f 2a 20 4e 65 78 74 20 73 75        /* Next su
0e10: 62 2d 70 72 6f 67 72 61 6d 20 61 6c 72 65 61 64  b-program alread
0e20: 79 20 76 69 73 69 74 65 64 20 2a 2f 0a 7d 3b 0a  y visited */.};.
0e30: 0a 2f 2a 0a 2a 2a 20 41 20 73 6d 61 6c 6c 65 72  ./*.** A smaller
0e40: 20 76 65 72 73 69 6f 6e 20 6f 66 20 56 64 62 65   version of Vdbe
0e50: 4f 70 20 75 73 65 64 20 66 6f 72 20 74 68 65 20  Op used for the 
0e60: 56 64 62 65 41 64 64 4f 70 4c 69 73 74 28 29 20  VdbeAddOpList() 
0e70: 66 75 6e 63 74 69 6f 6e 20 62 65 63 61 75 73 65  function because
0e80: 0a 2a 2a 20 69 74 20 74 61 6b 65 73 20 75 70 20  .** it takes up 
0e90: 6c 65 73 73 20 73 70 61 63 65 2e 0a 2a 2f 0a 73  less space..*/.s
0ea0: 74 72 75 63 74 20 56 64 62 65 4f 70 4c 69 73 74  truct VdbeOpList
0eb0: 20 7b 0a 20 20 75 38 20 6f 70 63 6f 64 65 3b 20   {.  u8 opcode; 
0ec0: 20 20 20 20 20 20 20 20 20 2f 2a 20 57 68 61 74           /* What
0ed0: 20 6f 70 65 72 61 74 69 6f 6e 20 74 6f 20 70 65   operation to pe
0ee0: 72 66 6f 72 6d 20 2a 2f 0a 20 20 73 69 67 6e 65  rform */.  signe
0ef0: 64 20 63 68 61 72 20 70 31 3b 20 20 20 20 20 2f  d char p1;     /
0f00: 2a 20 46 69 72 73 74 20 6f 70 65 72 61 6e 64 20  * First operand 
0f10: 2a 2f 0a 20 20 73 69 67 6e 65 64 20 63 68 61 72  */.  signed char
0f20: 20 70 32 3b 20 20 20 20 20 2f 2a 20 53 65 63 6f   p2;     /* Seco
0f30: 6e 64 20 70 61 72 61 6d 65 74 65 72 20 28 6f 66  nd parameter (of
0f40: 74 65 6e 20 74 68 65 20 6a 75 6d 70 20 64 65 73  ten the jump des
0f50: 74 69 6e 61 74 69 6f 6e 29 20 2a 2f 0a 20 20 73  tination) */.  s
0f60: 69 67 6e 65 64 20 63 68 61 72 20 70 33 3b 20 20  igned char p3;  
0f70: 20 20 20 2f 2a 20 54 68 69 72 64 20 70 61 72 61     /* Third para
0f80: 6d 65 74 65 72 20 2a 2f 0a 7d 3b 0a 74 79 70 65  meter */.};.type
0f90: 64 65 66 20 73 74 72 75 63 74 20 56 64 62 65 4f  def struct VdbeO
0fa0: 70 4c 69 73 74 20 56 64 62 65 4f 70 4c 69 73 74  pList VdbeOpList
0fb0: 3b 0a 0a 2f 2a 0a 2a 2a 20 41 6c 6c 6f 77 65 64  ;../*.** Allowed
0fc0: 20 76 61 6c 75 65 73 20 6f 66 20 56 64 62 65 4f   values of VdbeO
0fd0: 70 2e 70 34 74 79 70 65 0a 2a 2f 0a 23 64 65 66  p.p4type.*/.#def
0fe0: 69 6e 65 20 50 34 5f 4e 4f 54 55 53 45 44 20 20  ine P4_NOTUSED  
0ff0: 20 20 30 20 20 20 2f 2a 20 54 68 65 20 50 34 20    0   /* The P4 
1000: 70 61 72 61 6d 65 74 65 72 20 69 73 20 6e 6f 74  parameter is not
1010: 20 75 73 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65   used */.#define
1020: 20 50 34 5f 44 59 4e 41 4d 49 43 20 20 28 2d 31   P4_DYNAMIC  (-1
1030: 29 20 20 2f 2a 20 50 6f 69 6e 74 65 72 20 74 6f  )  /* Pointer to
1040: 20 61 20 73 74 72 69 6e 67 20 6f 62 74 61 69 6e   a string obtain
1050: 65 64 20 66 72 6f 6d 20 73 71 6c 69 74 65 4d 61  ed from sqliteMa
1060: 6c 6c 6f 63 28 29 20 2a 2f 0a 23 64 65 66 69 6e  lloc() */.#defin
1070: 65 20 50 34 5f 53 54 41 54 49 43 20 20 20 28 2d  e P4_STATIC   (-
1080: 32 29 20 20 2f 2a 20 50 6f 69 6e 74 65 72 20 74  2)  /* Pointer t
1090: 6f 20 61 20 73 74 61 74 69 63 20 73 74 72 69 6e  o a static strin
10a0: 67 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f  g */.#define P4_
10b0: 43 4f 4c 4c 53 45 51 20 20 28 2d 34 29 20 20 2f  COLLSEQ  (-4)  /
10c0: 2a 20 50 34 20 69 73 20 61 20 70 6f 69 6e 74 65  * P4 is a pointe
10d0: 72 20 74 6f 20 61 20 43 6f 6c 6c 53 65 71 20 73  r to a CollSeq s
10e0: 74 72 75 63 74 75 72 65 20 2a 2f 0a 23 64 65 66  tructure */.#def
10f0: 69 6e 65 20 50 34 5f 46 55 4e 43 44 45 46 20 20  ine P4_FUNCDEF  
1100: 28 2d 35 29 20 20 2f 2a 20 50 34 20 69 73 20 61  (-5)  /* P4 is a
1110: 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 46 75   pointer to a Fu
1120: 6e 63 44 65 66 20 73 74 72 75 63 74 75 72 65 20  ncDef structure 
1130: 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f 4b 45  */.#define P4_KE
1140: 59 49 4e 46 4f 20 20 28 2d 36 29 20 20 2f 2a 20  YINFO  (-6)  /* 
1150: 50 34 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20  P4 is a pointer 
1160: 74 6f 20 61 20 4b 65 79 49 6e 66 6f 20 73 74 72  to a KeyInfo str
1170: 75 63 74 75 72 65 20 2a 2f 0a 23 64 65 66 69 6e  ucture */.#defin
1180: 65 20 50 34 5f 45 58 50 52 20 20 20 20 20 28 2d  e P4_EXPR     (-
1190: 37 29 20 20 2f 2a 20 50 34 20 69 73 20 61 20 70  7)  /* P4 is a p
11a0: 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 45 78 70  ointer to an Exp
11b0: 72 20 74 72 65 65 20 2a 2f 0a 23 64 65 66 69 6e  r tree */.#defin
11c0: 65 20 50 34 5f 4d 45 4d 20 20 20 20 20 20 28 2d  e P4_MEM      (-
11d0: 38 29 20 20 2f 2a 20 50 34 20 69 73 20 61 20 70  8)  /* P4 is a p
11e0: 6f 69 6e 74 65 72 20 74 6f 20 61 20 4d 65 6d 2a  ointer to a Mem*
11f0: 20 20 20 20 73 74 72 75 63 74 75 72 65 20 2a 2f      structure */
1200: 0a 23 64 65 66 69 6e 65 20 50 34 5f 54 52 41 4e  .#define P4_TRAN
1210: 53 49 45 4e 54 20 20 30 20 20 20 2f 2a 20 50 34  SIENT  0   /* P4
1220: 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f   is a pointer to
1230: 20 61 20 74 72 61 6e 73 69 65 6e 74 20 73 74 72   a transient str
1240: 69 6e 67 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50  ing */.#define P
1250: 34 5f 56 54 41 42 20 20 20 20 20 28 2d 31 30 29  4_VTAB     (-10)
1260: 20 2f 2a 20 50 34 20 69 73 20 61 20 70 6f 69 6e   /* P4 is a poin
1270: 74 65 72 20 74 6f 20 61 6e 20 73 71 6c 69 74 65  ter to an sqlite
1280: 33 5f 76 74 61 62 20 73 74 72 75 63 74 75 72 65  3_vtab structure
1290: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f 4d   */.#define P4_M
12a0: 50 52 49 4e 54 46 20 20 28 2d 31 31 29 20 2f 2a  PRINTF  (-11) /*
12b0: 20 50 34 20 69 73 20 61 20 73 74 72 69 6e 67 20   P4 is a string 
12c0: 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 73 71  obtained from sq
12d0: 6c 69 74 65 33 5f 6d 70 72 69 6e 74 66 28 29 20  lite3_mprintf() 
12e0: 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f 52 45  */.#define P4_RE
12f0: 41 4c 20 20 20 20 20 28 2d 31 32 29 20 2f 2a 20  AL     (-12) /* 
1300: 50 34 20 69 73 20 61 20 36 34 2d 62 69 74 20 66  P4 is a 64-bit f
1310: 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 76 61  loating point va
1320: 6c 75 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50  lue */.#define P
1330: 34 5f 49 4e 54 36 34 20 20 20 20 28 2d 31 33 29  4_INT64    (-13)
1340: 20 2f 2a 20 50 34 20 69 73 20 61 20 36 34 2d 62   /* P4 is a 64-b
1350: 69 74 20 73 69 67 6e 65 64 20 69 6e 74 65 67 65  it signed intege
1360: 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f  r */.#define P4_
1370: 49 4e 54 33 32 20 20 20 20 28 2d 31 34 29 20 2f  INT32    (-14) /
1380: 2a 20 50 34 20 69 73 20 61 20 33 32 2d 62 69 74  * P4 is a 32-bit
1390: 20 73 69 67 6e 65 64 20 69 6e 74 65 67 65 72 20   signed integer 
13a0: 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f 49 4e  */.#define P4_IN
13b0: 54 41 52 52 41 59 20 28 2d 31 35 29 20 2f 2a 20  TARRAY (-15) /* 
13c0: 50 34 20 69 73 20 61 20 76 65 63 74 6f 72 20 6f  P4 is a vector o
13d0: 66 20 33 32 2d 62 69 74 20 69 6e 74 65 67 65 72  f 32-bit integer
13e0: 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f  s */.#define P4_
13f0: 53 55 42 50 52 4f 47 52 41 4d 20 20 28 2d 31 38  SUBPROGRAM  (-18
1400: 29 20 2f 2a 20 50 34 20 69 73 20 61 20 70 6f 69  ) /* P4 is a poi
1410: 6e 74 65 72 20 74 6f 20 61 20 53 75 62 50 72 6f  nter to a SubPro
1420: 67 72 61 6d 20 73 74 72 75 63 74 75 72 65 20 2a  gram structure *
1430: 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f 41 44 56  /.#define P4_ADV
1440: 41 4e 43 45 20 20 28 2d 31 39 29 20 2f 2a 20 50  ANCE  (-19) /* P
1450: 34 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74  4 is a pointer t
1460: 6f 20 42 74 72 65 65 4e 65 78 74 28 29 20 6f 72  o BtreeNext() or
1470: 20 42 74 72 65 65 50 72 65 76 28 29 20 2a 2f 0a   BtreePrev() */.
1480: 23 64 65 66 69 6e 65 20 50 34 5f 54 41 42 4c 45  #define P4_TABLE
1490: 20 20 20 20 28 2d 32 30 29 20 2f 2a 20 50 34 20      (-20) /* P4 
14a0: 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  is a pointer to 
14b0: 61 20 54 61 62 6c 65 20 73 74 72 75 63 74 75 72  a Table structur
14c0: 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 34 5f  e */.#define P4_
14d0: 46 55 4e 43 43 54 58 20 20 28 2d 32 31 29 20 2f  FUNCCTX  (-21) /
14e0: 2a 20 50 34 20 69 73 20 61 20 70 6f 69 6e 74 65  * P4 is a pointe
14f0: 72 20 74 6f 20 61 6e 20 73 71 6c 69 74 65 33 5f  r to an sqlite3_
1500: 63 6f 6e 74 65 78 74 20 6f 62 6a 65 63 74 20 2a  context object *
1510: 2f 0a 0a 2f 2a 20 45 72 72 6f 72 20 6d 65 73 73  /../* Error mess
1520: 61 67 65 20 63 6f 64 65 73 20 66 6f 72 20 4f 50  age codes for OP
1530: 5f 48 61 6c 74 20 2a 2f 0a 23 64 65 66 69 6e 65  _Halt */.#define
1540: 20 50 35 5f 43 6f 6e 73 74 72 61 69 6e 74 4e 6f   P5_ConstraintNo
1550: 74 4e 75 6c 6c 20 31 0a 23 64 65 66 69 6e 65 20  tNull 1.#define 
1560: 50 35 5f 43 6f 6e 73 74 72 61 69 6e 74 55 6e 69  P5_ConstraintUni
1570: 71 75 65 20 20 32 0a 23 64 65 66 69 6e 65 20 50  que  2.#define P
1580: 35 5f 43 6f 6e 73 74 72 61 69 6e 74 43 68 65 63  5_ConstraintChec
1590: 6b 20 20 20 33 0a 23 64 65 66 69 6e 65 20 50 35  k   3.#define P5
15a0: 5f 43 6f 6e 73 74 72 61 69 6e 74 46 4b 20 20 20  _ConstraintFK   
15b0: 20 20 20 34 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20     4../*.** The 
15c0: 56 64 62 65 2e 61 43 6f 6c 4e 61 6d 65 20 61 72  Vdbe.aColName ar
15d0: 72 61 79 20 63 6f 6e 74 61 69 6e 73 20 35 6e 20  ray contains 5n 
15e0: 4d 65 6d 20 73 74 72 75 63 74 75 72 65 73 2c 20  Mem structures, 
15f0: 77 68 65 72 65 20 6e 20 69 73 20 74 68 65 20 0a  where n is the .
1600: 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c  ** number of col
1610: 75 6d 6e 73 20 6f 66 20 64 61 74 61 20 72 65 74  umns of data ret
1620: 75 72 6e 65 64 20 62 79 20 74 68 65 20 73 74 61  urned by the sta
1630: 74 65 6d 65 6e 74 2e 0a 2a 2f 0a 23 64 65 66 69  tement..*/.#defi
1640: 6e 65 20 43 4f 4c 4e 41 4d 45 5f 4e 41 4d 45 20  ne COLNAME_NAME 
1650: 20 20 20 20 30 0a 23 64 65 66 69 6e 65 20 43 4f      0.#define CO
1660: 4c 4e 41 4d 45 5f 44 45 43 4c 54 59 50 45 20 31  LNAME_DECLTYPE 1
1670: 0a 23 64 65 66 69 6e 65 20 43 4f 4c 4e 41 4d 45  .#define COLNAME
1680: 5f 44 41 54 41 42 41 53 45 20 32 0a 23 64 65 66  _DATABASE 2.#def
1690: 69 6e 65 20 43 4f 4c 4e 41 4d 45 5f 54 41 42 4c  ine COLNAME_TABL
16a0: 45 20 20 20 20 33 0a 23 64 65 66 69 6e 65 20 43  E    3.#define C
16b0: 4f 4c 4e 41 4d 45 5f 43 4f 4c 55 4d 4e 20 20 20  OLNAME_COLUMN   
16c0: 34 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f  4.#ifdef SQLITE_
16d0: 45 4e 41 42 4c 45 5f 43 4f 4c 55 4d 4e 5f 4d 45  ENABLE_COLUMN_ME
16e0: 54 41 44 41 54 41 0a 23 20 64 65 66 69 6e 65 20  TADATA.# define 
16f0: 43 4f 4c 4e 41 4d 45 5f 4e 20 20 20 20 20 20 20  COLNAME_N       
1700: 20 35 20 20 20 20 20 20 2f 2a 20 4e 75 6d 62 65   5      /* Numbe
1710: 72 20 6f 66 20 43 4f 4c 4e 41 4d 45 5f 78 78 78  r of COLNAME_xxx
1720: 20 73 79 6d 62 6f 6c 73 20 2a 2f 0a 23 65 6c 73   symbols */.#els
1730: 65 0a 23 20 69 66 64 65 66 20 53 51 4c 49 54 45  e.# ifdef SQLITE
1740: 5f 4f 4d 49 54 5f 44 45 43 4c 54 59 50 45 0a 23  _OMIT_DECLTYPE.#
1750: 20 20 20 64 65 66 69 6e 65 20 43 4f 4c 4e 41 4d     define COLNAM
1760: 45 5f 4e 20 20 20 20 20 20 31 20 20 20 20 20 20  E_N      1      
1770: 2f 2a 20 53 74 6f 72 65 20 6f 6e 6c 79 20 74 68  /* Store only th
1780: 65 20 6e 61 6d 65 20 2a 2f 0a 23 20 65 6c 73 65  e name */.# else
1790: 0a 23 20 20 20 64 65 66 69 6e 65 20 43 4f 4c 4e  .#   define COLN
17a0: 41 4d 45 5f 4e 20 20 20 20 20 20 32 20 20 20 20  AME_N      2    
17b0: 20 20 2f 2a 20 53 74 6f 72 65 20 74 68 65 20 6e    /* Store the n
17c0: 61 6d 65 20 61 6e 64 20 64 65 63 6c 74 79 70 65  ame and decltype
17d0: 20 2a 2f 0a 23 20 65 6e 64 69 66 0a 23 65 6e 64   */.# endif.#end
17e0: 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 66 6f  if../*.** The fo
17f0: 6c 6c 6f 77 69 6e 67 20 6d 61 63 72 6f 20 63 6f  llowing macro co
1800: 6e 76 65 72 74 73 20 61 20 72 65 6c 61 74 69 76  nverts a relativ
1810: 65 20 61 64 64 72 65 73 73 20 69 6e 20 74 68 65  e address in the
1820: 20 70 32 20 66 69 65 6c 64 0a 2a 2a 20 6f 66 20   p2 field.** of 
1830: 61 20 56 64 62 65 4f 70 20 73 74 72 75 63 74 75  a VdbeOp structu
1840: 72 65 20 69 6e 74 6f 20 61 20 6e 65 67 61 74 69  re into a negati
1850: 76 65 20 6e 75 6d 62 65 72 20 73 6f 20 74 68 61  ve number so tha
1860: 74 20 0a 2a 2a 20 73 71 6c 69 74 65 33 56 64 62  t .** sqlite3Vdb
1870: 65 41 64 64 4f 70 4c 69 73 74 28 29 20 6b 6e 6f  eAddOpList() kno
1880: 77 73 20 74 68 61 74 20 74 68 65 20 61 64 64 72  ws that the addr
1890: 65 73 73 20 69 73 20 72 65 6c 61 74 69 76 65 2e  ess is relative.
18a0: 20 20 43 61 6c 6c 69 6e 67 0a 2a 2a 20 74 68 65    Calling.** the
18b0: 20 6d 61 63 72 6f 20 61 67 61 69 6e 20 72 65 73   macro again res
18c0: 74 6f 72 65 73 20 74 68 65 20 61 64 64 72 65 73  tores the addres
18d0: 73 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 41 44  s..*/.#define AD
18e0: 44 52 28 58 29 20 20 28 2d 31 2d 28 58 29 29 0a  DR(X)  (-1-(X)).
18f0: 0a 2f 2a 0a 2a 2a 20 54 68 65 20 6d 61 6b 65 66  ./*.** The makef
1900: 69 6c 65 20 73 63 61 6e 73 20 74 68 65 20 76 64  ile scans the vd
1910: 62 65 2e 63 20 73 6f 75 72 63 65 20 66 69 6c 65  be.c source file
1920: 20 61 6e 64 20 63 72 65 61 74 65 73 20 74 68 65   and creates the
1930: 20 22 6f 70 63 6f 64 65 73 2e 68 22 0a 2a 2a 20   "opcodes.h".** 
1940: 68 65 61 64 65 72 20 66 69 6c 65 20 74 68 61 74  header file that
1950: 20 64 65 66 69 6e 65 73 20 61 20 6e 75 6d 62 65   defines a numbe
1960: 72 20 66 6f 72 20 65 61 63 68 20 6f 70 63 6f 64  r for each opcod
1970: 65 20 75 73 65 64 20 62 79 20 74 68 65 20 56 44  e used by the VD
1980: 42 45 2e 0a 2a 2f 0a 23 69 6e 63 6c 75 64 65 20  BE..*/.#include 
1990: 22 6f 70 63 6f 64 65 73 2e 68 22 0a 0a 2f 2a 0a  "opcodes.h"../*.
19a0: 2a 2a 20 50 72 6f 74 6f 74 79 70 65 73 20 66 6f  ** Prototypes fo
19b0: 72 20 74 68 65 20 56 44 42 45 20 69 6e 74 65 72  r the VDBE inter
19c0: 66 61 63 65 2e 20 20 53 65 65 20 63 6f 6d 6d 65  face.  See comme
19d0: 6e 74 73 20 6f 6e 20 74 68 65 20 69 6d 70 6c 65  nts on the imple
19e0: 6d 65 6e 74 61 74 69 6f 6e 0a 2a 2a 20 66 6f 72  mentation.** for
19f0: 20 61 20 64 65 73 63 72 69 70 74 69 6f 6e 20 6f   a description o
1a00: 66 20 77 68 61 74 20 65 61 63 68 20 6f 66 20 74  f what each of t
1a10: 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 64 6f  hese routines do
1a20: 65 73 2e 0a 2a 2f 0a 56 64 62 65 20 2a 73 71 6c  es..*/.Vdbe *sql
1a30: 69 74 65 33 56 64 62 65 43 72 65 61 74 65 28 50  ite3VdbeCreate(P
1a40: 61 72 73 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  arse*);.int sqli
1a50: 74 65 33 56 64 62 65 41 64 64 4f 70 30 28 56 64  te3VdbeAddOp0(Vd
1a60: 62 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  be*,int);.int sq
1a70: 6c 69 74 65 33 56 64 62 65 41 64 64 4f 70 31 28  lite3VdbeAddOp1(
1a80: 56 64 62 65 2a 2c 69 6e 74 2c 69 6e 74 29 3b 0a  Vdbe*,int,int);.
1a90: 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62 65 41  int sqlite3VdbeA
1aa0: 64 64 4f 70 32 28 56 64 62 65 2a 2c 69 6e 74 2c  ddOp2(Vdbe*,int,
1ab0: 69 6e 74 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  int,int);.int sq
1ac0: 6c 69 74 65 33 56 64 62 65 47 6f 74 6f 28 56 64  lite3VdbeGoto(Vd
1ad0: 62 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  be*,int);.int sq
1ae0: 6c 69 74 65 33 56 64 62 65 4c 6f 61 64 53 74 72  lite3VdbeLoadStr
1af0: 69 6e 67 28 56 64 62 65 2a 2c 69 6e 74 2c 63 6f  ing(Vdbe*,int,co
1b00: 6e 73 74 20 63 68 61 72 2a 29 3b 0a 76 6f 69 64  nst char*);.void
1b10: 20 73 71 6c 69 74 65 33 56 64 62 65 4d 75 6c 74   sqlite3VdbeMult
1b20: 69 4c 6f 61 64 28 56 64 62 65 2a 2c 69 6e 74 2c  iLoad(Vdbe*,int,
1b30: 63 6f 6e 73 74 20 63 68 61 72 2a 2c 2e 2e 2e 29  const char*,...)
1b40: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62  ;.int sqlite3Vdb
1b50: 65 41 64 64 4f 70 33 28 56 64 62 65 2a 2c 69 6e  eAddOp3(Vdbe*,in
1b60: 74 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74 29 3b 0a  t,int,int,int);.
1b70: 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62 65 41  int sqlite3VdbeA
1b80: 64 64 4f 70 34 28 56 64 62 65 2a 2c 69 6e 74 2c  ddOp4(Vdbe*,int,
1b90: 69 6e 74 2c 69 6e 74 2c 69 6e 74 2c 63 6f 6e 73  int,int,int,cons
1ba0: 74 20 63 68 61 72 20 2a 7a 50 34 2c 69 6e 74 29  t char *zP4,int)
1bb0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62  ;.int sqlite3Vdb
1bc0: 65 41 64 64 4f 70 34 44 75 70 38 28 56 64 62 65  eAddOp4Dup8(Vdbe
1bd0: 2a 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74 2c 69 6e  *,int,int,int,in
1be0: 74 2c 63 6f 6e 73 74 20 75 38 2a 2c 69 6e 74 29  t,const u8*,int)
1bf0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62  ;.int sqlite3Vdb
1c00: 65 41 64 64 4f 70 34 49 6e 74 28 56 64 62 65 2a  eAddOp4Int(Vdbe*
1c10: 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74  ,int,int,int,int
1c20: 2c 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69  ,int);.void sqli
1c30: 74 65 33 56 64 62 65 45 6e 64 43 6f 72 6f 75 74  te3VdbeEndCorout
1c40: 69 6e 65 28 56 64 62 65 2a 2c 69 6e 74 29 3b 0a  ine(Vdbe*,int);.
1c50: 23 69 66 20 64 65 66 69 6e 65 64 28 53 51 4c 49  #if defined(SQLI
1c60: 54 45 5f 44 45 42 55 47 29 20 26 26 20 21 64 65  TE_DEBUG) && !de
1c70: 66 69 6e 65 64 28 53 51 4c 49 54 45 5f 54 45 53  fined(SQLITE_TES
1c80: 54 5f 52 45 41 4c 4c 4f 43 5f 53 54 52 45 53 53  T_REALLOC_STRESS
1c90: 29 0a 20 20 76 6f 69 64 20 73 71 6c 69 74 65 33  ).  void sqlite3
1ca0: 56 64 62 65 56 65 72 69 66 79 4e 6f 4d 61 6c 6c  VdbeVerifyNoMall
1cb0: 6f 63 52 65 71 75 69 72 65 64 28 56 64 62 65 20  ocRequired(Vdbe 
1cc0: 2a 70 2c 20 69 6e 74 20 4e 29 3b 0a 23 65 6c 73  *p, int N);.#els
1cd0: 65 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74  e.# define sqlit
1ce0: 65 33 56 64 62 65 56 65 72 69 66 79 4e 6f 4d 61  e3VdbeVerifyNoMa
1cf0: 6c 6c 6f 63 52 65 71 75 69 72 65 64 28 41 2c 42  llocRequired(A,B
1d00: 29 0a 23 65 6e 64 69 66 0a 56 64 62 65 4f 70 20  ).#endif.VdbeOp 
1d10: 2a 73 71 6c 69 74 65 33 56 64 62 65 41 64 64 4f  *sqlite3VdbeAddO
1d20: 70 4c 69 73 74 28 56 64 62 65 2a 2c 20 69 6e 74  pList(Vdbe*, int
1d30: 20 6e 4f 70 2c 20 56 64 62 65 4f 70 4c 69 73 74   nOp, VdbeOpList
1d40: 20 63 6f 6e 73 74 20 2a 61 4f 70 2c 20 69 6e 74   const *aOp, int
1d50: 20 69 4c 69 6e 65 6e 6f 29 3b 0a 76 6f 69 64 20   iLineno);.void 
1d60: 73 71 6c 69 74 65 33 56 64 62 65 41 64 64 50 61  sqlite3VdbeAddPa
1d70: 72 73 65 53 63 68 65 6d 61 4f 70 28 56 64 62 65  rseSchemaOp(Vdbe
1d80: 2a 2c 69 6e 74 2c 63 68 61 72 2a 29 3b 0a 76 6f  *,int,char*);.vo
1d90: 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 43 68  id sqlite3VdbeCh
1da0: 61 6e 67 65 4f 70 63 6f 64 65 28 56 64 62 65 2a  angeOpcode(Vdbe*
1db0: 2c 20 75 33 32 20 61 64 64 72 2c 20 75 38 29 3b  , u32 addr, u8);
1dc0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62  .void sqlite3Vdb
1dd0: 65 43 68 61 6e 67 65 50 31 28 56 64 62 65 2a 2c  eChangeP1(Vdbe*,
1de0: 20 75 33 32 20 61 64 64 72 2c 20 69 6e 74 20 50   u32 addr, int P
1df0: 31 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  1);.void sqlite3
1e00: 56 64 62 65 43 68 61 6e 67 65 50 32 28 56 64 62  VdbeChangeP2(Vdb
1e10: 65 2a 2c 20 75 33 32 20 61 64 64 72 2c 20 69 6e  e*, u32 addr, in
1e20: 74 20 50 32 29 3b 0a 76 6f 69 64 20 73 71 6c 69  t P2);.void sqli
1e30: 74 65 33 56 64 62 65 43 68 61 6e 67 65 50 33 28  te3VdbeChangeP3(
1e40: 56 64 62 65 2a 2c 20 75 33 32 20 61 64 64 72 2c  Vdbe*, u32 addr,
1e50: 20 69 6e 74 20 50 33 29 3b 0a 76 6f 69 64 20 73   int P3);.void s
1e60: 71 6c 69 74 65 33 56 64 62 65 43 68 61 6e 67 65  qlite3VdbeChange
1e70: 50 35 28 56 64 62 65 2a 2c 20 75 38 20 50 35 29  P5(Vdbe*, u8 P5)
1e80: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64  ;.void sqlite3Vd
1e90: 62 65 4a 75 6d 70 48 65 72 65 28 56 64 62 65 2a  beJumpHere(Vdbe*
1ea0: 2c 20 69 6e 74 20 61 64 64 72 29 3b 0a 69 6e 74  , int addr);.int
1eb0: 20 73 71 6c 69 74 65 33 56 64 62 65 43 68 61 6e   sqlite3VdbeChan
1ec0: 67 65 54 6f 4e 6f 6f 70 28 56 64 62 65 2a 2c 20  geToNoop(Vdbe*, 
1ed0: 69 6e 74 20 61 64 64 72 29 3b 0a 69 6e 74 20 73  int addr);.int s
1ee0: 71 6c 69 74 65 33 56 64 62 65 44 65 6c 65 74 65  qlite3VdbeDelete
1ef0: 50 72 69 6f 72 4f 70 63 6f 64 65 28 56 64 62 65  PriorOpcode(Vdbe
1f00: 2a 2c 20 75 38 20 6f 70 29 3b 0a 76 6f 69 64 20  *, u8 op);.void 
1f10: 73 71 6c 69 74 65 33 56 64 62 65 43 68 61 6e 67  sqlite3VdbeChang
1f20: 65 50 34 28 56 64 62 65 2a 2c 20 69 6e 74 20 61  eP4(Vdbe*, int a
1f30: 64 64 72 2c 20 63 6f 6e 73 74 20 63 68 61 72 20  ddr, const char 
1f40: 2a 7a 50 34 2c 20 69 6e 74 20 4e 29 3b 0a 76 6f  *zP4, int N);.vo
1f50: 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 53 65  id sqlite3VdbeSe
1f60: 74 50 34 4b 65 79 49 6e 66 6f 28 50 61 72 73 65  tP4KeyInfo(Parse
1f70: 2a 2c 20 49 6e 64 65 78 2a 29 3b 0a 76 6f 69 64  *, Index*);.void
1f80: 20 73 71 6c 69 74 65 33 56 64 62 65 55 73 65 73   sqlite3VdbeUses
1f90: 42 74 72 65 65 28 56 64 62 65 2a 2c 20 69 6e 74  Btree(Vdbe*, int
1fa0: 29 3b 0a 56 64 62 65 4f 70 20 2a 73 71 6c 69 74  );.VdbeOp *sqlit
1fb0: 65 33 56 64 62 65 47 65 74 4f 70 28 56 64 62 65  e3VdbeGetOp(Vdbe
1fc0: 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  *, int);.int sql
1fd0: 69 74 65 33 56 64 62 65 4d 61 6b 65 4c 61 62 65  ite3VdbeMakeLabe
1fe0: 6c 28 56 64 62 65 2a 29 3b 0a 76 6f 69 64 20 73  l(Vdbe*);.void s
1ff0: 71 6c 69 74 65 33 56 64 62 65 52 75 6e 4f 6e 6c  qlite3VdbeRunOnl
2000: 79 4f 6e 63 65 28 56 64 62 65 2a 29 3b 0a 76 6f  yOnce(Vdbe*);.vo
2010: 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 52 65  id sqlite3VdbeRe
2020: 75 73 61 62 6c 65 28 56 64 62 65 2a 29 3b 0a 76  usable(Vdbe*);.v
2030: 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 44  oid sqlite3VdbeD
2040: 65 6c 65 74 65 28 56 64 62 65 2a 29 3b 0a 76 6f  elete(Vdbe*);.vo
2050: 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 43 6c  id sqlite3VdbeCl
2060: 65 61 72 4f 62 6a 65 63 74 28 73 71 6c 69 74 65  earObject(sqlite
2070: 33 2a 2c 56 64 62 65 2a 29 3b 0a 76 6f 69 64 20  3*,Vdbe*);.void 
2080: 73 71 6c 69 74 65 33 56 64 62 65 4d 61 6b 65 52  sqlite3VdbeMakeR
2090: 65 61 64 79 28 56 64 62 65 2a 2c 50 61 72 73 65  eady(Vdbe*,Parse
20a0: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56  *);.int sqlite3V
20b0: 64 62 65 46 69 6e 61 6c 69 7a 65 28 56 64 62 65  dbeFinalize(Vdbe
20c0: 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  *);.void sqlite3
20d0: 56 64 62 65 52 65 73 6f 6c 76 65 4c 61 62 65 6c  VdbeResolveLabel
20e0: 28 56 64 62 65 2a 2c 20 69 6e 74 29 3b 0a 69 6e  (Vdbe*, int);.in
20f0: 74 20 73 71 6c 69 74 65 33 56 64 62 65 43 75 72  t sqlite3VdbeCur
2100: 72 65 6e 74 41 64 64 72 28 56 64 62 65 2a 29 3b  rentAddr(Vdbe*);
2110: 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 44  .#ifdef SQLITE_D
2120: 45 42 55 47 0a 20 20 69 6e 74 20 73 71 6c 69 74  EBUG.  int sqlit
2130: 65 33 56 64 62 65 41 73 73 65 72 74 4d 61 79 41  e3VdbeAssertMayA
2140: 62 6f 72 74 28 56 64 62 65 20 2a 2c 20 69 6e 74  bort(Vdbe *, int
2150: 29 3b 0a 23 65 6e 64 69 66 0a 76 6f 69 64 20 73  );.#endif.void s
2160: 71 6c 69 74 65 33 56 64 62 65 52 65 73 65 74 53  qlite3VdbeResetS
2170: 74 65 70 52 65 73 75 6c 74 28 56 64 62 65 2a 29  tepResult(Vdbe*)
2180: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64  ;.void sqlite3Vd
2190: 62 65 52 65 77 69 6e 64 28 56 64 62 65 2a 29 3b  beRewind(Vdbe*);
21a0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62 65  .int sqlite3Vdbe
21b0: 52 65 73 65 74 28 56 64 62 65 2a 29 3b 0a 76 6f  Reset(Vdbe*);.vo
21c0: 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 53 65  id sqlite3VdbeSe
21d0: 74 4e 75 6d 43 6f 6c 73 28 56 64 62 65 2a 2c 69  tNumCols(Vdbe*,i
21e0: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
21f0: 56 64 62 65 53 65 74 43 6f 6c 4e 61 6d 65 28 56  VdbeSetColName(V
2200: 64 62 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 2c 20  dbe*, int, int, 
2210: 63 6f 6e 73 74 20 63 68 61 72 20 2a 2c 20 76 6f  const char *, vo
2220: 69 64 28 2a 29 28 76 6f 69 64 2a 29 29 3b 0a 76  id(*)(void*));.v
2230: 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 43  oid sqlite3VdbeC
2240: 6f 75 6e 74 43 68 61 6e 67 65 73 28 56 64 62 65  ountChanges(Vdbe
2250: 2a 29 3b 0a 73 71 6c 69 74 65 33 20 2a 73 71 6c  *);.sqlite3 *sql
2260: 69 74 65 33 56 64 62 65 44 62 28 56 64 62 65 2a  ite3VdbeDb(Vdbe*
2270: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56  );.void sqlite3V
2280: 64 62 65 53 65 74 53 71 6c 28 56 64 62 65 2a 2c  dbeSetSql(Vdbe*,
2290: 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 2c 20   const char *z, 
22a0: 69 6e 74 20 6e 2c 20 69 6e 74 29 3b 0a 76 6f 69  int n, int);.voi
22b0: 64 20 73 71 6c 69 74 65 33 56 64 62 65 53 77 61  d sqlite3VdbeSwa
22c0: 70 28 56 64 62 65 2a 2c 56 64 62 65 2a 29 3b 0a  p(Vdbe*,Vdbe*);.
22d0: 56 64 62 65 4f 70 20 2a 73 71 6c 69 74 65 33 56  VdbeOp *sqlite3V
22e0: 64 62 65 54 61 6b 65 4f 70 41 72 72 61 79 28 56  dbeTakeOpArray(V
22f0: 64 62 65 2a 2c 20 69 6e 74 2a 2c 20 69 6e 74 2a  dbe*, int*, int*
2300: 29 3b 0a 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  );.sqlite3_value
2310: 20 2a 73 71 6c 69 74 65 33 56 64 62 65 47 65 74   *sqlite3VdbeGet
2320: 42 6f 75 6e 64 56 61 6c 75 65 28 56 64 62 65 2a  BoundValue(Vdbe*
2330: 2c 20 69 6e 74 2c 20 75 38 29 3b 0a 76 6f 69 64  , int, u8);.void
2340: 20 73 71 6c 69 74 65 33 56 64 62 65 53 65 74 56   sqlite3VdbeSetV
2350: 61 72 6d 61 73 6b 28 56 64 62 65 2a 2c 20 69 6e  armask(Vdbe*, in
2360: 74 29 3b 0a 23 69 66 6e 64 65 66 20 53 51 4c 49  t);.#ifndef SQLI
2370: 54 45 5f 4f 4d 49 54 5f 54 52 41 43 45 0a 20 20  TE_OMIT_TRACE.  
2380: 63 68 61 72 20 2a 73 71 6c 69 74 65 33 56 64 62  char *sqlite3Vdb
2390: 65 45 78 70 61 6e 64 53 71 6c 28 56 64 62 65 2a  eExpandSql(Vdbe*
23a0: 2c 20 63 6f 6e 73 74 20 63 68 61 72 2a 29 3b 0a  , const char*);.
23b0: 23 65 6e 64 69 66 0a 69 6e 74 20 73 71 6c 69 74  #endif.int sqlit
23c0: 65 33 4d 65 6d 43 6f 6d 70 61 72 65 28 63 6f 6e  e3MemCompare(con
23d0: 73 74 20 4d 65 6d 2a 2c 20 63 6f 6e 73 74 20 4d  st Mem*, const M
23e0: 65 6d 2a 2c 20 63 6f 6e 73 74 20 43 6f 6c 6c 53  em*, const CollS
23f0: 65 71 2a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69  eq*);..void sqli
2400: 74 65 33 56 64 62 65 52 65 63 6f 72 64 55 6e 70  te3VdbeRecordUnp
2410: 61 63 6b 28 4b 65 79 49 6e 66 6f 2a 2c 69 6e 74  ack(KeyInfo*,int
2420: 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 55 6e 70  ,const void*,Unp
2430: 61 63 6b 65 64 52 65 63 6f 72 64 2a 29 3b 0a 69  ackedRecord*);.i
2440: 6e 74 20 73 71 6c 69 74 65 33 56 64 62 65 52 65  nt sqlite3VdbeRe
2450: 63 6f 72 64 43 6f 6d 70 61 72 65 28 69 6e 74 2c  cordCompare(int,
2460: 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 55 6e 70 61  const void*,Unpa
2470: 63 6b 65 64 52 65 63 6f 72 64 2a 29 3b 0a 69 6e  ckedRecord*);.in
2480: 74 20 73 71 6c 69 74 65 33 56 64 62 65 52 65 63  t sqlite3VdbeRec
2490: 6f 72 64 43 6f 6d 70 61 72 65 57 69 74 68 53 6b  ordCompareWithSk
24a0: 69 70 28 69 6e 74 2c 20 63 6f 6e 73 74 20 76 6f  ip(int, const vo
24b0: 69 64 20 2a 2c 20 55 6e 70 61 63 6b 65 64 52 65  id *, UnpackedRe
24c0: 63 6f 72 64 20 2a 2c 20 69 6e 74 29 3b 0a 55 6e  cord *, int);.Un
24d0: 70 61 63 6b 65 64 52 65 63 6f 72 64 20 2a 73 71  packedRecord *sq
24e0: 6c 69 74 65 33 56 64 62 65 41 6c 6c 6f 63 55 6e  lite3VdbeAllocUn
24f0: 70 61 63 6b 65 64 52 65 63 6f 72 64 28 4b 65 79  packedRecord(Key
2500: 49 6e 66 6f 20 2a 2c 20 63 68 61 72 20 2a 2c 20  Info *, char *, 
2510: 69 6e 74 2c 20 63 68 61 72 20 2a 2a 29 3b 0a 0a  int, char **);..
2520: 74 79 70 65 64 65 66 20 69 6e 74 20 28 2a 52 65  typedef int (*Re
2530: 63 6f 72 64 43 6f 6d 70 61 72 65 29 28 69 6e 74  cordCompare)(int
2540: 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 55 6e 70  ,const void*,Unp
2550: 61 63 6b 65 64 52 65 63 6f 72 64 2a 29 3b 0a 52  ackedRecord*);.R
2560: 65 63 6f 72 64 43 6f 6d 70 61 72 65 20 73 71 6c  ecordCompare sql
2570: 69 74 65 33 56 64 62 65 46 69 6e 64 43 6f 6d 70  ite3VdbeFindComp
2580: 61 72 65 28 55 6e 70 61 63 6b 65 64 52 65 63 6f  are(UnpackedReco
2590: 72 64 2a 29 3b 0a 0a 23 69 66 6e 64 65 66 20 53  rd*);..#ifndef S
25a0: 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 52 49 47 47  QLITE_OMIT_TRIGG
25b0: 45 52 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56  ER.void sqlite3V
25c0: 64 62 65 4c 69 6e 6b 53 75 62 50 72 6f 67 72 61  dbeLinkSubProgra
25d0: 6d 28 56 64 62 65 20 2a 2c 20 53 75 62 50 72 6f  m(Vdbe *, SubPro
25e0: 67 72 61 6d 20 2a 29 3b 0a 23 65 6e 64 69 66 0a  gram *);.#endif.
25f0: 0a 2f 2a 20 55 73 65 20 53 51 4c 49 54 45 5f 45  ./* Use SQLITE_E
2600: 4e 41 42 4c 45 5f 43 4f 4d 4d 45 4e 54 53 20 74  NABLE_COMMENTS t
2610: 6f 20 65 6e 61 62 6c 65 20 67 65 6e 65 72 61 74  o enable generat
2620: 69 6f 6e 20 6f 66 20 65 78 74 72 61 20 63 6f 6d  ion of extra com
2630: 6d 65 6e 74 73 20 6f 6e 0a 2a 2a 20 65 61 63 68  ments on.** each
2640: 20 56 44 42 45 20 6f 70 63 6f 64 65 2e 0a 2a 2a   VDBE opcode..**
2650: 0a 2a 2a 20 55 73 65 20 74 68 65 20 53 51 4c 49  .** Use the SQLI
2660: 54 45 5f 45 4e 41 42 4c 45 5f 4d 4f 44 55 4c 45  TE_ENABLE_MODULE
2670: 5f 43 4f 4d 4d 45 4e 54 53 20 6d 61 63 72 6f 20  _COMMENTS macro 
2680: 74 6f 20 73 65 65 20 73 6f 6d 65 20 65 78 74 72  to see some extr
2690: 61 20 6e 6f 2d 6f 70 0a 2a 2a 20 63 6f 6d 6d 65  a no-op.** comme
26a0: 6e 74 73 20 69 6e 20 56 44 42 45 20 70 72 6f 67  nts in VDBE prog
26b0: 72 61 6d 73 20 74 68 61 74 20 73 68 6f 77 20 6b  rams that show k
26c0: 65 79 20 64 65 63 69 73 69 6f 6e 20 70 6f 69 6e  ey decision poin
26d0: 74 73 20 69 6e 20 74 68 65 20 63 6f 64 65 0a 2a  ts in the code.*
26e0: 2a 20 67 65 6e 65 72 61 74 6f 72 2e 0a 2a 2f 0a  * generator..*/.
26f0: 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e  #ifdef SQLITE_EN
2700: 41 42 4c 45 5f 45 58 50 4c 41 49 4e 5f 43 4f 4d  ABLE_EXPLAIN_COM
2710: 4d 45 4e 54 53 0a 20 20 76 6f 69 64 20 73 71 6c  MENTS.  void sql
2720: 69 74 65 33 56 64 62 65 43 6f 6d 6d 65 6e 74 28  ite3VdbeComment(
2730: 56 64 62 65 2a 2c 20 63 6f 6e 73 74 20 63 68 61  Vdbe*, const cha
2740: 72 2a 2c 20 2e 2e 2e 29 3b 0a 23 20 64 65 66 69  r*, ...);.# defi
2750: 6e 65 20 56 64 62 65 43 6f 6d 6d 65 6e 74 28 58  ne VdbeComment(X
2760: 29 20 20 73 71 6c 69 74 65 33 56 64 62 65 43 6f  )  sqlite3VdbeCo
2770: 6d 6d 65 6e 74 20 58 0a 20 20 76 6f 69 64 20 73  mment X.  void s
2780: 71 6c 69 74 65 33 56 64 62 65 4e 6f 6f 70 43 6f  qlite3VdbeNoopCo
2790: 6d 6d 65 6e 74 28 56 64 62 65 2a 2c 20 63 6f 6e  mment(Vdbe*, con
27a0: 73 74 20 63 68 61 72 2a 2c 20 2e 2e 2e 29 3b 0a  st char*, ...);.
27b0: 23 20 64 65 66 69 6e 65 20 56 64 62 65 4e 6f 6f  # define VdbeNoo
27c0: 70 43 6f 6d 6d 65 6e 74 28 58 29 20 20 73 71 6c  pComment(X)  sql
27d0: 69 74 65 33 56 64 62 65 4e 6f 6f 70 43 6f 6d 6d  ite3VdbeNoopComm
27e0: 65 6e 74 20 58 0a 23 20 69 66 64 65 66 20 53 51  ent X.# ifdef SQ
27f0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 4f 44 55  LITE_ENABLE_MODU
2800: 4c 45 5f 43 4f 4d 4d 45 4e 54 53 0a 23 20 20 20  LE_COMMENTS.#   
2810: 64 65 66 69 6e 65 20 56 64 62 65 4d 6f 64 75 6c  define VdbeModul
2820: 65 43 6f 6d 6d 65 6e 74 28 58 29 20 20 73 71 6c  eComment(X)  sql
2830: 69 74 65 33 56 64 62 65 4e 6f 6f 70 43 6f 6d 6d  ite3VdbeNoopComm
2840: 65 6e 74 20 58 0a 23 20 65 6c 73 65 0a 23 20 20  ent X.# else.#  
2850: 20 64 65 66 69 6e 65 20 56 64 62 65 4d 6f 64 75   define VdbeModu
2860: 6c 65 43 6f 6d 6d 65 6e 74 28 58 29 0a 23 20 65  leComment(X).# e
2870: 6e 64 69 66 0a 23 65 6c 73 65 0a 23 20 64 65 66  ndif.#else.# def
2880: 69 6e 65 20 56 64 62 65 43 6f 6d 6d 65 6e 74 28  ine VdbeComment(
2890: 58 29 0a 23 20 64 65 66 69 6e 65 20 56 64 62 65  X).# define Vdbe
28a0: 4e 6f 6f 70 43 6f 6d 6d 65 6e 74 28 58 29 0a 23  NoopComment(X).#
28b0: 20 64 65 66 69 6e 65 20 56 64 62 65 4d 6f 64 75   define VdbeModu
28c0: 6c 65 43 6f 6d 6d 65 6e 74 28 58 29 0a 23 65 6e  leComment(X).#en
28d0: 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 56  dif../*.** The V
28e0: 64 62 65 43 6f 76 65 72 61 67 65 20 6d 61 63 72  dbeCoverage macr
28f0: 6f 73 20 61 72 65 20 75 73 65 64 20 74 6f 20 73  os are used to s
2900: 65 74 20 61 20 63 6f 76 65 72 61 67 65 20 74 65  et a coverage te
2910: 73 74 69 6e 67 20 70 6f 69 6e 74 0a 2a 2a 20 66  sting point.** f
2920: 6f 72 20 56 44 42 45 20 62 72 61 6e 63 68 20 69  or VDBE branch i
2930: 6e 73 74 72 75 63 74 69 6f 6e 73 2e 20 20 54 68  nstructions.  Th
2940: 65 20 63 6f 76 65 72 61 67 65 20 74 65 73 74 69  e coverage testi
2950: 6e 67 20 70 6f 69 6e 74 73 20 61 72 65 20 6c 69  ng points are li
2960: 6e 65 0a 2a 2a 20 6e 75 6d 62 65 72 73 20 69 6e  ne.** numbers in
2970: 20 74 68 65 20 73 71 6c 69 74 65 33 2e 63 20 73   the sqlite3.c s
2980: 6f 75 72 63 65 20 66 69 6c 65 2e 20 20 56 44 42  ource file.  VDB
2990: 45 20 62 72 61 6e 63 68 20 63 6f 76 65 72 61 67  E branch coverag
29a0: 65 20 74 65 73 74 69 6e 67 0a 2a 2a 20 6f 6e 6c  e testing.** onl
29b0: 79 20 77 6f 72 6b 73 20 77 69 74 68 20 61 6e 20  y works with an 
29c0: 61 6d 61 6c 61 67 6d 61 74 69 6f 6e 20 62 75 69  amalagmation bui
29d0: 6c 64 2e 20 20 54 68 61 74 27 73 20 6f 6b 20 73  ld.  That's ok s
29e0: 69 6e 63 65 20 61 20 56 44 42 45 20 62 72 61 6e  ince a VDBE bran
29f0: 63 68 0a 2a 2a 20 63 6f 76 65 72 61 67 65 20 62  ch.** coverage b
2a00: 75 69 6c 64 20 64 65 73 69 67 6e 65 64 20 66 6f  uild designed fo
2a10: 72 20 74 65 73 74 69 6e 67 20 74 68 65 20 74 65  r testing the te
2a20: 73 74 20 73 75 69 74 65 20 6f 6e 6c 79 2e 20 20  st suite only.  
2a30: 4e 6f 20 61 70 70 6c 69 63 61 74 69 6f 6e 0a 2a  No application.*
2a40: 2a 20 73 68 6f 75 6c 64 20 65 76 65 72 20 73 68  * should ever sh
2a50: 69 70 20 77 69 74 68 20 56 44 42 45 20 62 72 61  ip with VDBE bra
2a60: 6e 63 68 20 63 6f 76 65 72 61 67 65 20 6d 65 61  nch coverage mea
2a70: 73 75 72 69 6e 67 20 74 75 72 6e 65 64 20 6f 6e  suring turned on
2a80: 2e 0a 2a 2a 0a 2a 2a 20 20 20 20 56 64 62 65 43  ..**.**    VdbeC
2a90: 6f 76 65 72 61 67 65 28 76 29 20 20 20 20 20 20  overage(v)      
2aa0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2f 20 4d              // M
2ab0: 61 72 6b 20 74 68 65 20 70 72 65 76 69 6f 75 73  ark the previous
2ac0: 6c 79 20 63 6f 64 65 64 20 69 6e 73 74 72 75 63  ly coded instruc
2ad0: 74 69 6f 6e 0a 2a 2a 20 20 20 20 20 20 20 20 20  tion.**         
2ae0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2af0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2f 20 61              // a
2b00: 73 20 61 20 62 72 61 6e 63 68 0a 2a 2a 0a 2a 2a  s a branch.**.**
2b10: 20 20 20 20 56 64 62 65 43 6f 76 65 72 61 67 65      VdbeCoverage
2b20: 49 66 28 76 2c 20 63 6f 6e 64 69 74 69 6f 6e 61  If(v, conditiona
2b30: 6c 29 20 20 20 2f 2f 20 4d 61 72 6b 20 70 72 65  l)   // Mark pre
2b40: 76 69 6f 75 73 20 69 66 20 63 6f 6e 64 69 74 69  vious if conditi
2b50: 6f 6e 61 6c 20 74 72 75 65 0a 2a 2a 0a 2a 2a 20  onal true.**.** 
2b60: 20 20 20 56 64 62 65 43 6f 76 65 72 61 67 65 41     VdbeCoverageA
2b70: 6c 77 61 79 73 54 61 6b 65 6e 28 76 29 20 20 20  lwaysTaken(v)   
2b80: 20 20 20 20 2f 2f 20 50 72 65 76 69 6f 75 73 20      // Previous 
2b90: 62 72 61 6e 63 68 20 69 73 20 61 6c 77 61 79 73  branch is always
2ba0: 20 74 61 6b 65 6e 0a 2a 2a 0a 2a 2a 20 20 20 20   taken.**.**    
2bb0: 56 64 62 65 43 6f 76 65 72 61 67 65 4e 65 76 65  VdbeCoverageNeve
2bc0: 72 54 61 6b 65 6e 28 76 29 20 20 20 20 20 20 20  rTaken(v)       
2bd0: 20 2f 2f 20 50 72 65 76 69 6f 75 73 20 62 72 61   // Previous bra
2be0: 6e 63 68 20 69 73 20 6e 65 76 65 72 20 74 61 6b  nch is never tak
2bf0: 65 6e 0a 2a 2a 0a 2a 2a 20 45 76 65 72 79 20 56  en.**.** Every V
2c00: 44 42 45 20 62 72 61 6e 63 68 20 6f 70 65 72 61  DBE branch opera
2c10: 74 69 6f 6e 20 6d 75 73 74 20 62 65 20 74 61 67  tion must be tag
2c20: 67 65 64 20 77 69 74 68 20 6f 6e 65 20 6f 66 20  ged with one of 
2c30: 74 68 65 20 6d 61 63 72 6f 73 20 61 62 6f 76 65  the macros above
2c40: 2e 0a 2a 2a 20 49 66 20 6e 6f 74 2c 20 74 68 65  ..** If not, the
2c50: 6e 20 77 68 65 6e 20 22 6d 61 6b 65 20 74 65 73  n when "make tes
2c60: 74 22 20 69 73 20 72 75 6e 20 77 69 74 68 20 2d  t" is run with -
2c70: 44 53 51 4c 49 54 45 5f 56 44 42 45 5f 43 4f 56  DSQLITE_VDBE_COV
2c80: 45 52 41 47 45 20 61 6e 64 0a 2a 2a 20 2d 44 53  ERAGE and.** -DS
2c90: 51 4c 49 54 45 5f 44 45 42 55 47 20 74 68 65 6e  QLITE_DEBUG then
2ca0: 20 61 6e 20 41 4c 57 41 59 53 28 29 20 77 69 6c   an ALWAYS() wil
2cb0: 6c 20 66 61 69 6c 20 69 6e 20 74 68 65 20 76 64  l fail in the vd
2cc0: 62 65 54 61 6b 65 42 72 61 6e 63 68 28 29 0a 2a  beTakeBranch().*
2cd0: 2a 20 72 6f 75 74 69 6e 65 20 69 6e 20 76 64 62  * routine in vdb
2ce0: 65 2e 63 2c 20 61 6c 65 72 74 69 6e 67 20 74 68  e.c, alerting th
2cf0: 65 20 64 65 76 65 6c 6f 70 65 72 20 74 6f 20 74  e developer to t
2d00: 68 65 20 6d 69 73 73 65 64 20 74 61 67 2e 0a 2a  he missed tag..*
2d10: 2f 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f  /.#ifdef SQLITE_
2d20: 56 44 42 45 5f 43 4f 56 45 52 41 47 45 0a 20 20  VDBE_COVERAGE.  
2d30: 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62 65  void sqlite3Vdbe
2d40: 53 65 74 4c 69 6e 65 4e 75 6d 62 65 72 28 56 64  SetLineNumber(Vd
2d50: 62 65 2a 2c 69 6e 74 29 3b 0a 23 20 64 65 66 69  be*,int);.# defi
2d60: 6e 65 20 56 64 62 65 43 6f 76 65 72 61 67 65 28  ne VdbeCoverage(
2d70: 76 29 20 73 71 6c 69 74 65 33 56 64 62 65 53 65  v) sqlite3VdbeSe
2d80: 74 4c 69 6e 65 4e 75 6d 62 65 72 28 76 2c 5f 5f  tLineNumber(v,__
2d90: 4c 49 4e 45 5f 5f 29 0a 23 20 64 65 66 69 6e 65  LINE__).# define
2da0: 20 56 64 62 65 43 6f 76 65 72 61 67 65 49 66 28   VdbeCoverageIf(
2db0: 76 2c 78 29 20 69 66 28 78 29 73 71 6c 69 74 65  v,x) if(x)sqlite
2dc0: 33 56 64 62 65 53 65 74 4c 69 6e 65 4e 75 6d 62  3VdbeSetLineNumb
2dd0: 65 72 28 76 2c 5f 5f 4c 49 4e 45 5f 5f 29 0a 23  er(v,__LINE__).#
2de0: 20 64 65 66 69 6e 65 20 56 64 62 65 43 6f 76 65   define VdbeCove
2df0: 72 61 67 65 41 6c 77 61 79 73 54 61 6b 65 6e 28  rageAlwaysTaken(
2e00: 76 29 20 73 71 6c 69 74 65 33 56 64 62 65 53 65  v) sqlite3VdbeSe
2e10: 74 4c 69 6e 65 4e 75 6d 62 65 72 28 76 2c 32 29  tLineNumber(v,2)
2e20: 3b 0a 23 20 64 65 66 69 6e 65 20 56 64 62 65 43  ;.# define VdbeC
2e30: 6f 76 65 72 61 67 65 4e 65 76 65 72 54 61 6b 65  overageNeverTake
2e40: 6e 28 76 29 20 73 71 6c 69 74 65 33 56 64 62 65  n(v) sqlite3Vdbe
2e50: 53 65 74 4c 69 6e 65 4e 75 6d 62 65 72 28 76 2c  SetLineNumber(v,
2e60: 31 29 3b 0a 23 20 64 65 66 69 6e 65 20 56 44 42  1);.# define VDB
2e70: 45 5f 4f 46 46 53 45 54 5f 4c 49 4e 45 4e 4f 28  E_OFFSET_LINENO(
2e80: 78 29 20 28 5f 5f 4c 49 4e 45 5f 5f 2b 78 29 0a  x) (__LINE__+x).
2e90: 23 65 6c 73 65 0a 23 20 64 65 66 69 6e 65 20 56  #else.# define V
2ea0: 64 62 65 43 6f 76 65 72 61 67 65 28 76 29 0a 23  dbeCoverage(v).#
2eb0: 20 64 65 66 69 6e 65 20 56 64 62 65 43 6f 76 65   define VdbeCove
2ec0: 72 61 67 65 49 66 28 76 2c 78 29 0a 23 20 64 65  rageIf(v,x).# de
2ed0: 66 69 6e 65 20 56 64 62 65 43 6f 76 65 72 61 67  fine VdbeCoverag
2ee0: 65 41 6c 77 61 79 73 54 61 6b 65 6e 28 76 29 0a  eAlwaysTaken(v).
2ef0: 23 20 64 65 66 69 6e 65 20 56 64 62 65 43 6f 76  # define VdbeCov
2f00: 65 72 61 67 65 4e 65 76 65 72 54 61 6b 65 6e 28  erageNeverTaken(
2f10: 76 29 0a 23 20 64 65 66 69 6e 65 20 56 44 42 45  v).# define VDBE
2f20: 5f 4f 46 46 53 45 54 5f 4c 49 4e 45 4e 4f 28 78  _OFFSET_LINENO(x
2f30: 29 20 30 0a 23 65 6e 64 69 66 0a 0a 23 69 66 64  ) 0.#endif..#ifd
2f40: 65 66 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45  ef SQLITE_ENABLE
2f50: 5f 53 54 4d 54 5f 53 43 41 4e 53 54 41 54 55 53  _STMT_SCANSTATUS
2f60: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62  .void sqlite3Vdb
2f70: 65 53 63 61 6e 53 74 61 74 75 73 28 56 64 62 65  eScanStatus(Vdbe
2f80: 2a 2c 20 69 6e 74 2c 20 69 6e 74 2c 20 69 6e 74  *, int, int, int
2f90: 2c 20 4c 6f 67 45 73 74 2c 20 63 6f 6e 73 74 20  , LogEst, const 
2fa0: 63 68 61 72 2a 29 3b 0a 23 65 6c 73 65 0a 23 20  char*);.#else.# 
2fb0: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 56 64  define sqlite3Vd
2fc0: 62 65 53 63 61 6e 53 74 61 74 75 73 28 61 2c 62  beScanStatus(a,b
2fd0: 2c 63 2c 64 2c 65 29 0a 23 65 6e 64 69 66 0a 0a  ,c,d,e).#endif..
2fe0: 23 65 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45  #endif /* SQLITE
2ff0: 5f 56 44 42 45 5f 48 20 2a 2f 0a                 _VDBE_H */.